RSS Amplifier

Ask me about API docs · Nov 25, 2022

A definition for docs as code

0
Sign in to vote or save

Clarence W Cromwell · Ask me about API docs

The more questions I ask, the more it seems that people have slightly different ideas about the definition of the term "Docs as code."

Here's one definition, based on some of the best-known resources about docs as code.

* The docs are written in plain text.

* Source files are stored near the application code, usually in the same repo.

* The tools for editing and reviewing documentation are whatever the developers _in the same organization_ use to write code.

* Automation transforms the source files into a website and sometimes other forms of output.

* The reason for adopting all the measures above is to enable developers to write documentation.

The last bullet is the most frequently omitted from definitions of docs as code, but I would say that it's the most important.

Coming up: More about Docs as Code and other toolchains.

No posts

Read the original on askmeaboutapis.substack.com

Comments

Nothing yet. Say the first thing.

    Sign in to join the conversation.