Articles

In the first part of our new Docs As Code series, you will read about the philosophy behind the approach coupled with Quality Assurance, and how you can get started.

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.

How to improve API documentation and learning experiences inspired by the Dreyfus model of skill acquisition. An overview of content and DX elements that help developers along their learning journey.

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.

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.