Articles
Everything on developer portals from strategy and business to technology and visual design.
Sign up to our newsletter to make sure you don't miss out.
Categories
Software Development Kits (SDKs)
The main purpose of Platform Software Development Kits and Helper/Client Libraries is to accelerate and simplify development. A well maintained SDK is a trust signal that indicates the level of support and usage of your API for a language, framework, or development platform. In this post, we’ll look at how the developer portals in our research sample included SDKs.
FAQs, Forums and Other Support Resources
Self-service support is arguably the most important role of a developer portal. In absence of proper documentation, API teams can spend hours on training, onboarding, and support effort. In this post we analyze the characteristics of a number of support resources and look at how they involve their users to develop information about the problem areas for an API’s use.
Reference Pages
Once a developer knows how to use your API, they will need detailed instructions on how to build the actual integration. Experienced developers already familiar with an API, including its creators, will have a hard time completing an integration without access to the API reference. In this post we’ll show how the developer portals in our research sample implemented their reference pages, compare their formats and labels, and try to deduct best practices you could apply on your developer portal.
Guides and Tutorials
The function of the guides and tutorial pages that are linked from an onboarding page is to fulfill the expectation of learning and to design an experience that will be as close as possible to the learning requirements of key audience segments. In this post, we will explore how the sites we reviewed included guides and tutorials in their information architecture, we’ll look at what they covered, and finish with listing what could help to maximize their effectiveness.
Onboarding Pages
Onboarding pages need to hook the developer. In this article we’ll list the various roles onboarding pages need to fulfill, explore how the developer portals we reviewed expose them and how they are labelled.
Overview Pages
The "Overview Page" provides a devportal with an entrance page for developers to start exploring. What are strategies to structure information? What is the function of your developer portal? What to know to build an appealing overview page.
Pagination
Editor's Choice
Developer portals: your undercover brand ambassadors
by Szabina OláhCategories:
Business Value and Strategy
Unleash the Power of AI: Make Your APIs Future-Proof with APIs.json
by Christoph WeberCategories:
Business Value and Strategy