Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

Are there some advice you can give for writing good documentation


The biggest piece of advice I can give is keep it short and put more important information up front. Every doc should start with a one-sentence plain language description of the thing's purpose and context.

Pascal once wrote in apology "If I had more time, I would have written a shorter letter". Be exactly as detailed as necessary and no longer.


Check out https://diataxis.fr/

I think this "documentation framework" has helped me a lot to write precise docs and how to structure everything regardless of the platform


Thanks — took the day to work through it. Really cleared some things up conceptually




Consider applying for YC's Summer 2026 batch! Applications are open till May 4

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

Search: