Add "documentation is more than you think" article #4
+164
−11
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for yanthomasdev ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
sarah11918
reviewed
Feb 2, 2026
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
yanthomasdev
commented
Feb 2, 2026
delucis
reviewed
Feb 2, 2026
Contributor
delucis
left a comment
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.
|
|
||
| - 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. |
Contributor
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.
Owner
Author
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>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.