Articles

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.

A developer portal is more than just the documentation for an API. As a sort of self-service support hub, it is a key DevRel tool that helps an organization to provide the best possible developer experience for its APIs. A developer portal has a role in support, marketing, sales, and engineering. A conversation on the #documenting-apis WTD slack channel sparked the idea for this blog post.

At the API days in London, I gave a presentation about developer portals. In it I shared mental models and frameworks that I think can help improve the quality of a developer portal: I decided to write 6 dedicated blog posts about what I discussed.

APIs are going to transform the world: they not only benefit from network effects caused by specialisation, the data they collect also makes them a prime candidate for the emergence of specialised Artificial Intelligence. Considering how powerful APIs are, it would be an injustice should they remain the privilege of developers.