Hacker News new | past | comments | ask | show | jobs | submit login
How to write exceptional documentation (chrisnicholas.dev)
6 points by ctnicholas 70 days ago | hide | past | favorite | 3 comments



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.


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.


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




Consider applying for YC's Summer 2025 batch! Applications are open till May 13

Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: