4 ms·
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 understandin
by beachy 3y ago
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-documentation/ 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.