this post was submitted on 07 Nov 2024
212 points (98.2% liked)

Programmer Humor

32396 readers
1513 users here now

Post funny things about programming here! (Or just rant about your favourite programming language.)

Rules:

founded 5 years ago
MODERATORS
 
you are viewing a single comment's thread
view the rest of the comments
[–] [email protected] 5 points 19 hours ago

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.