CI/CD and Docs-as-Code workflow

CI/CD and Docs-as-Code workflow

September 16, 2020

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.

Read more
How to Improve DocOps using CI/CD and Docs-as-Code

How to Improve DocOps using CI/CD and Docs-as-Code

March 4, 2020

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.

Read more
Going beyond Usability with Developer Portals

Going beyond Usability with Developer Portals

February 18, 2020

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.

Read more
Basic Graphical Elements of Developer Portals

Basic Graphical Elements of Developer Portals

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

Read more
Overall Design Style of Developer Portals

Overall Design Style of Developer Portals

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

Read more
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
User-focused Content Design for API Documentation

User-focused Content Design for API Documentation

January 31, 2019

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.

Read more