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

Keep documentation close to the source to increase the odds it gets updated. Prefer READMEs to Wikis, and use source comments to generate docs rather than word/google docs. Some doc tools even test examples for you!

It's not perfect, and good documentation is an art, but if you care about your software and your users you'll try to communicate clearly.



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

Search: