The older I get, the less time passes between starting a new project and reading the readme / manpages for a library.
this post was submitted on 07 Nov 2024
231 points (98.7% liked)
Programmer Humor
32448 readers
991 users here now
Post funny things about programming here! (Or just rant about your favourite programming language.)
Rules:
- Posts must be relevant to programming, programmers, or computer science.
- No NSFW content.
- Jokes must be in good taste. No hate speech, bigotry, etc.
founded 5 years ago
MODERATORS
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.
Ah yes, they demonstrate my use case in the getting started section. I am an arrogant fool.
In the balkans we have a funny term for that - MUP, which stands for Metoda Uzaludnih Pokušaja, the 'method of futile attempts'.
Finally reading instructions for the TARDIS?