Settings

Theme

How to write exceptional documentation

chrisnicholas.dev

6 points by ctnicholas 9 months ago · 3 comments

Reader

unbalancedevh 9 months ago

This looks like a very good template for user documentation. As a developer, I find that I struggle with balancing the documentation for what the user needs; what my co-workers need so that they can collaborate and approve whatever I'm implementing; and what management needs to convince them that it meets requirements and is ready for production. Having templates or checklists to compare to is a good way to able to quickly evaluate which aspects haven't been addressed yet and whether or not that's ok/appropriate for the given task.

ctnicholasOP 9 months ago

Hey all, I'm the writer! I thought I'd share this since a couple of my interactive articles went down quite well on here.

Happy to answer any questions.

stevenfabre 9 months ago

This blog post is a piece of art. Well done!

Keyboard Shortcuts

j
Next item
k
Previous item
o / Enter
Open selected item
?
Show this help
Esc
Close modal / clear selection