Add "documentation is more than you think" article - #4
Conversation
✅ Deploy Preview for yanthomasdev ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Uh oh!
There was an error while loading. Please reload this page.
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
Uh oh!
There was an error while loading. Please reload this page.
delucis
left a comment
There was a problem hiding this comment.
Exciting Yan! Left a couple of quick notes, plus as I mentioned elsewhere, might be good to switch up headings to be “Docs are…” instead of “It is…”.
Read up to the empathy section so far. Will try to catch up with the rest later.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
| - No one is responsible for it: your documentation needs a "head chef", they're the one responsible for ensuring everything is following the recipe and standards set. Generally, this should be your Senior/Staff Technical Writer or Docs Lead. | ||
| Investing in documentation is investing in quality. The same way you need someone to architect the words that are written for the computer so that it's clean, efficient, and maintainable, you need someone who architects the words that are written for the much less precise, imperfect, and more critical human beings. |
There was a problem hiding this comment.
Nit: “architect” as a verb is not something I love, here it feels a bit clunky, but you can have it if you want it.
There was a problem hiding this comment.
yeah, I went with "architect" more for the analogy with software architecture, maybe "engineer"? But then I think it would have the same problem 😅
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
Uh oh!
There was an error while loading. Please reload this page.
No description provided.