undefined | Better HN

0 pointsdocmechanic4y ago0 comments

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

0 comments

3 comments · 1 top-level

maxerickson4y ago· 2 in thread

The quoted text says "as" and clearly intends that meaning.

docmechanicOP4y ago

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
"

maxerickson4y ago

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.

1 more reply

j / k navigate · click thread line to collapse