Articles

Why is it essential to establish a clear documentation workflow? How can developers, project managers (PMs), and techwriters work closely together without being a bottleneck? You may be familiar with these issues or looking for a better solution to make the customer and internal (in-house) documentation workflows more efficient. In this article, we recap what we covered in our webinar, and publish the answers to the audience's questions.

We aim to equip you with insights to enhance your developer portal, whether by incorporating user-centered design to already planned content, or by strategically choosing the most effective guide type to improve the API integration experience.

We explored free and open-source API documentation solutions, and compiled the results of our research in this post.

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.

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.