A practical introduction to Documentation as Code

by David Garcia, Principal consultant

We all value good product docs, but writing them is another story. The pressure to launch the product doesn't leave you time to take care of documentation. And when there is, you don't feel productive since you know they might become outdated as soon as there is a new version of the software.

In this workshop recorded for PyCON APAC 2020, I show you the techniques and tools I use to keep documentation projects current while enjoyable to maintain.

We'll host the docs in GitHub near its source code, write them with restructuredText, generate a beautiful site with Sphinx, use ReadTheDocs to automate the publication process, and Vale to test them.

I hope this was a helpful introduction to Docs as Code! To know more about Docs as Code, I recommend you to join the fantastic WriteTheDocs Community and check other articles on Docs as Code in our blog Software Documentation.

Let's talk about docs.

Do you want to create great products for technical audiences? Dive into the topic with our articles on technical writing, developer experience, and Docs as Code.