Re:Markdoc: Stripe's Markdown-based authoring framework
by maxerickson on Wednesday May 11, 2022 @04:51PM
(#31345597)
The quoted text says "as" and clearly intends that meaning.
Re:Markdoc: Stripe's Markdown-based authoring framework
by docmechanic on Wednesday May 11, 2022 @06:49PM
(#31346960)
Ah, thank you for the term in question. Found a relevant link: 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
"
Re:Markdoc: Stripe's Markdown-based authoring framework
by maxerickson on Wednesday May 11, 2022 @09:15PM
(#31348044)
That'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.
Re:Markdoc: Stripe's Markdown-based authoring framework
by docmechanic on Thursday May 12, 2022 @05:06AM
(#31351155)
Yes, 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.
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