2 ms·
The biggest issue I've come across with some documentation is that it comes across as too "academic". Yes, it's very detailed, but doesn't immediately answer a
by charlie0 4y ago
The biggest issue I've come across with some documentation is that it comes across as too "academic". Yes, it's very detailed, but doesn't immediately answer a very specific question.
One good example is the Angular documentation. It's very detailed, but rarely does it answer the question I have. Reading the documentation just leaves me with more questions than I started.
Of course, I will say this. I don't come from an OOP background, so maybe that's why it doesn't immediately click.
The other problem with documentation is lack of examples. That's why for command line help, I use tldr. 90% of the time, it gives me an example of the exact command I need.
Believe me, I get the whole RTFM and for things I plan to use often enough, I will definitely RTFM. But for rarely used commands, it does not make sense to spend even 10 minutes reading arcane documentation. It's much more efficient to skim a blog or two (or use something like tldr), find the command with the switches and copy pasta. The prevalence of these blogs in the results show others think the same way or there wouldn't be so many of them.