|
|
|
|
|
by DeborahWrites
412 days ago
|
|
Thanks for pointing this out. The post starts from the assumption that people have at least heard of "docs like code", because it's a widely-used term/practice in tech writing. So I was aiming at tech writers who heard the term, but lacked the knowledge to use the technique (original draft of the post was in response to a less technical tech writer asking me a ton of questions) But perhaps I need to explain this up top, rather than hoping people will hang in there until the explanatory section. |
|
But it's not. You have got the key phrase wrong!
It's Docs as Code.
There are whole websites devoted to it:
https://docsascode.org/
Not "like": As -- meaning, "create docs as you create code", meaning "using the same tools and methods."
There is a good strong evidence that your version is inferior: the dozens of comments in this thread by people baffled by the phrase, or pointing out its flawed construction.
It's the Docs As Code approach, _NOT_ "docs like code".
https://docascod.github.io/howto/#/
https://marketplace.visualstudio.com/items?itemName=rafaelmn...
https://www.synesthesia.co.uk/tag/docsascode/