4 ms·
Just a gentle reminder that docs like code has an actual definition that we can refer to. When we say treat the docs like code, we mean that you: * Store the d
by docmechanic 4y ago
Just a gentle reminder that docs like code has an actual definition that we can refer to.
When we say treat the docs like code, we mean that you:
* Store the doc source files in a version control system.
* Build the doc artifacts automatically.
* Ensure that a trusted set of reviewers meticulously review the docs.
* Publish the artifacts without much human intervention.
Docs Like Code, Anne Gentle, p. 10
- maxerickson 4y agoThe quoted text says "as" and clearly intends that meaning.
- docmechanic 4y agoAh, thank you for the term in question. Found a relevant link: https://www.writethedocs.org/guide/docs-as-code/ https://www.writethedocs.org/guide/docs-as-code/ "There is a lot more to building a proper Docs as Code workflow. There are a couple books we recommend that you check out: Docs Like Code - Anne Gentle Modern Technical Writing - Andrew Etter "
- maxerickson 4y agoThat's not how language works, their phrase (that does not actually have a widely used established meaning) means what they meant, not what you say it means.
- docmechanic 4y agoYes, that term does have a widely established meaning within the specific context of discussion, technical writing. If the commentator is unaware of what 'docs as code' means in the context under discussion and meant something different, I encourage them to disambiguate by picking a term not already so defined.