I find it extremely frustrating how weirdly wrong-density much documentation is. It’s extremely detailed in all the wrong places and often lacks examples for common use cases.
I learned a while ago that news articles are supposed to have increasing levels of detail from top to bottom. Each paragraph adds a bit more context, but the general picture should be contained in the first one. Hardly any documentation follows that pattern.
The older I get, the less time passes between starting a new project and reading the readme / manpages for a library.
Learning to learn:
Also tldr: https://github.com/tldr-pages/tldr
I find it extremely frustrating how weirdly wrong-density much documentation is. It’s extremely detailed in all the wrong places and often lacks examples for common use cases.
I learned a while ago that news articles are supposed to have increasing levels of detail from top to bottom. Each paragraph adds a bit more context, but the general picture should be contained in the first one. Hardly any documentation follows that pattern.