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

Producing great documentation requires the same kind of judgement as designing the system in the first place: if you can consistently put yourself in the mind of your reader, then your code, your APIs, and your documentation will all be much better.

More documentation is not necessarily better. Just like code, the best documentation is the documentation you never had to write because you found a simpler way, and eliminated the issue completely.



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

Search: