Docs As Code

Have the whole team deliver current, useful, documentation using the minimum of effort
Contributed by
Published July 22, 2021
Collection
0

What Is Docs As Code?

Docs As Code (also known as “Docs Like Code”) is a popular approach to delivering documentation for software projects.

There are three common themes that you can expect to see.

  1. Adopt an “agile” approach to content creation, namely
  2. The whole team is responsible for content
  3. Be adaptive and improve both your content, and your process, over time.

Tools and processes will need to be adapted for your project (and then adapted again for the project after that).

Docs As Code image copyright Anne Gentle. Released under and MIT license.

Why Do Docs As Code?

  1. Deliver valuable documentation faster with higher quality (multiple voices, collaboration)
  2. Stop documentation being a bottleneck in the release cycle
  3. Release technical writers to deliver higher value content (information architecture, customer experience, ....)
  4. Remove need for proprietary technical writing tools

How to do Docs As Code?

Use developer tools, and process, to create and deliver content. Specifically:

  1. Text based file content with embedded, lightweight, markup tags
  2. Developer based workflows. For example:
    1. Version Control using tools such as Git
    2. Change control driven though bugs and feature requests tickets
    3. Content reviews and merges
  3. Machine generated content
  4. Automated testing and verification
  5. Rapid online publication using web pages (using static site generators) or wikis. For example Sphinx or Hugo.

Look at Docs As Code

Links we love

Check out these great links which can help you dive a little deeper into running the Docs As Code practice with your team, customers or stakeholders.

Discuss with the Community


Open Practice Library Logo
Open Practice Library

powered by

Open Innovation Labs Logo
Connect with our Community:
Except where noted, content on this site is licensed under a Creative Commons Attribution 4.0 International license.