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.

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

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.

In this guest post Jenny Wanger, Product Manager at Arity, gives an overview of the most important developer experience KPIs (key performance indicators).

Seven years ago I had the chance to visit China, and I had a great time exploring the cultural heritage, large cities and gastronomy. So when my talk got accepted for the first DevRelCon in Asia, I was excited to see China again — this time from a professional point of view.

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.