Most engineers I know rush to youtube or medium or some other outsourced interpretation of the docs that is far more scattered in info. I was wondering what made you (if you're one of the types that prefers medium/YT over the documentation) prefer these off-hand interpretations of a program rather than the one who created it ?
Ask HN: Why doesn't anyone ever read the docs?
1–10 of 13 posts
Re: Ask HN: Why doesn't anyone ever read the docs?
#2A matter of generational cultural conditioning I guess.
Re: Ask HN: Why doesn't anyone ever read the docs?
#32. Documentation is written by super smart people designed the software... they tend to have a tough time relating to normal developers and especially beginners
3. Docs never provide enough examples. Stack overflow literally exists for this reason
4. Documentation is an after thought for most pieces of software (laravel is a notable example to the contrary - the docs are part of the software design for laravel), and not a forethought.
5. People just don't read period
6. Documentation usually has contrived examples, where other sources often have literally the think that you were trying to do (Users, Posts, Payments, Tags, etc)
Short list... but hopefully helpful
Re: Ask HN: Why doesn't anyone ever read the docs?
#4Re: Ask HN: Why doesn't anyone ever read the docs?
#5Users start fresh. If users had spent as much time as the one documenting they would probably love the documentation, but since they are new, the viewpoint differs.
Truly good and intelligent documentation tries to capture the mindset of the assumed reader.
Re: Ask HN: Why doesn't anyone ever read the docs?
#6Re: Ask HN: Why doesn't anyone ever read the docs?
#7Sometimes medium is better because it has examples. I want the direct answer to my problem, the one liner. I don’t have time to read a book/doc.
Re: Ask HN: Why doesn't anyone ever read the docs?
#8I have a piece of software and a task I want to accomplish. For example, list files ordered by size in ascending order. ls' man page tells me how to do that, but I have to piece the information together because it is arranged option by option. Thus, I'm forced to read more than what I'd like.
Or I can google "ls sort files by size" click on the first link https://alvinalexander.com/photos/linux-ls-command-how-sort-... and voila.
Most people writing docs don't get that people learn by example. Thus the docs they write lacks examples and therefore are not very useful.
Re: Ask HN: Why doesn't anyone ever read the docs?
#9Because the documentation seldom is good and almost never really good. Long and "complete" documentation isn't the same thing as good documentation. I have a piece of software and a task I want to accomplish. For example, list files ordered by size in ascending order. ls' man page tells me how to do that, but I have to piece the information together because it is arranged option by option. Thus, I'm forced to read mo…
If you don't take time to read the entire manpage or at least skim through to find the optimal solution, then you're not experienced enough IMO. I understand the rush to come up with a quick win and amaze everyone, but the first quality I notice on senior engineers is that they were really slow in delivering solutions. The ROI would come up later when drawbacks were documented, the solution was well explained and most of the times elegant, hence no one would need to touch that part of system anytime soon and if someone did had to do so, he'd have a head-start.
Re: Ask HN: Why doesn't anyone ever read the docs?
#10Because the documentation seldom is good and almost never really good. Long and "complete" documentation isn't the same thing as good documentation. I have a piece of software and a task I want to accomplish. For example, list files ordered by size in ascending order. ls' man page tells me how to do that, but I have to piece the information together because it is arranged option by option. Thus, I'm forced to read mo…
> I have a piece of software and a task I want to accomplish. For example, list files ordered by size in ascending order. ls' man page tells me how to do that, but I have to piece the information together because it is arranged option by option. Thus, I'm forced to read more than what I'd like. If you don't take time to read the entire manpage or at least skim through to find the optimal solution, then you're not exp…