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

The article talks about four kinds of necessary documentation for large projects: explanation, reference, how-to guides, and tutorials. Auto-generated docs, even when they're very good, only provide one of those -- the reference.

Even if you have great inline documentation that can be turned into a great external reference document, you need separate documentation.



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

Search: