Articles

The author examined 23 blogs to explore how they can serve the portal users’ needs throughout the 6 stages of the developer journey.

On the Write The Docs London meetup in January speakers from leading Git code repositories talked about how their teams dogfood their own tools to do their documentation. _Version the Docs_ covered Bitbucket and GitLab, but we missed a GitHub presentation. To fill this gap, we interviewed Anne Gentle about GitHub, treating docs like code, and community contributions to documentation.

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.

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.

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 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.