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

Certainly writing is a skill that many programmers are not good at.

However IMO an easy trap to fall into is to start documenting without a bigger understanding of the audience and the purpose of the doc.

A good way to start is to identify which of the 4 types of documentation you are working on.

https://nick.groenen.me/posts/the-4-types-of-technical-docum...

Personally I find it very easy to put too much explanation in the wrong places.



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

Search: