Developer Portal Layout and Navigation

Developer Portal Layout and Navigation

October 10, 2019

In our Devportal Design Guide series, you will read about common design patterns, get an insight into our project work related experiences, and learn how we tackle the design of a developer portal user interface.

Part 2: Developer portal layout and navigation

Read more
Devportals on Different Devices: Responsiveness

Devportals on Different Devices: Responsiveness

October 1, 2019

In our Developer Portal Design Guide series, you will read about common design patterns, get an insight into our project work related experiences, and learn how we tackle the design of a developer portal user interface.

Part 1: Developer portals on different devices & responsiveness

Read more
Analyzing the API docs and DX Patterns in the Best Media Developer Portals 2

Analyzing the API docs and DX Patterns in the Best Media Developer Portals 2

March 7, 2019

After stock photo companies, video player software providers and audio distribution platforms this article will analyze developer portals in the journalism industry. We focused on two types of news organizations: the traditional ones that already existed before the digital era (such as TV channels, newspapers or radios) and those that were born web-based (and serve as online data providers). Our research revealed some of the differences in their approach to developer portals.

Read more
The Function of API Use Cases & Case Studies on Developer Portals

The Function of API Use Cases & Case Studies on Developer Portals

October 25, 2017

Should use cases and case studies be part of your API documentation? They play two crucial roles on a developer portal: They act as social proof for your API product (sales function) and they can be an introduction to more specific, implementation scenario documentation types.
We explored these fringe documentation types, both on business sites and developer portals, of 18 API companies with different profiles.

Read more
Treat docs like code

Treat docs like code

July 27, 2017

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.

Read more
Software Development Kits (SDKs)

Software Development Kits (SDKs)

December 23, 2016

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.

Read more
FAQs, Forums and Other Support Resources

FAQs, Forums and Other Support Resources

November 23, 2016

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.

Read more
Reference Pages

Reference Pages

November 17, 2016

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.

Read more