Articles

What is CI/CD development? How does CI/CD relate to docs-as-code? How can I write and maintain human-readable documentation while incorporating an automated testing framework to my review process? We provide an infographic and a description that illustrates our take on how CI/CD documentation, DocOps, and the Docs-as-code integrate.

In this article, we outline the basic principles of Docs-as-Code, some tools for writing and running automated tests against your documentation, and how these workflows can help improve the quality of your documentation. Using VS Code, git workflows, and automated documentation quality tests with Vale, we’ll show you how these tools can be used in concert in your DocOps setup.

Starting from an academic study, we explored further to outline the engagement attributes that go beyond usability by encouraging your user’s to play an active role in the success of your developer portal. We explain what engagement attributes are, how you can benefit, and give practical examples of how to implement them for your developer portal strategy.

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 5: Further visual solutions to improve the user experience

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 4: Basic graphical elements that support functionality

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 3: Overall design style

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

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

In the second part of our series, you will discover analytics and why it’s needed for Docs As Code. This post is focusing on the functional basis of Quality Assurance.

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.

At APIdays Paris 2018, Ronnie Mitra gave an insightful talk on how to improve API documentation and learning experiences, for which he gathered inspiration from the Dreyfus model of skill acquisition.

In this post, we’ll dive a little deeper into the whole topic and illustrate Ronnie’s conclusions by giving an overview of content and DX elements we imagine would help developers along their learning journey.