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

I believe documentation can be highly beneficial, but only when it's done well. The article makes some good points on this, but, just based on experience and common sense, documentation should be centralized, clean and descriptive enough, while not being too wordy or plain gibberish.

That's not easy to achieve and takes time and resources to get right. That's primarly why so many fail or give up on it.

The results can very much be worth the effort, however, the ones who should be responsible for the documenting process likely don't see its importance. From their perspective, what they've worked on is easy to understand and requires little to no explanation. Taking time to change this mindset and create proper documentation is an effort many are unwilling to take.



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

Search: