Every story and comment from the Hacker News API, in a layout borrowed from 2001.
A comment on The Surprising Power of Documentation. Parent comment
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.
There are no comments on this comment yet.
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.