|
|
|
|
|
|
by dspillett
762 days ago
|
|
|
> if the documentation isn't meeting the users' needs it is poor documentation Unless they are not reading it, or properly paying attention. Or following an unofficial document and blaming the core project for failings in that. Sometimes it is on the user. > With too much documentation the information might be there, but you aren't able to find it. It can also became a huge burden to maintain, meaning it is in danger of becoming out of date or inconsistent. |
|
|
If they make no effort, sure. But looking for an answer to a question and finding something that seems to works is a perfectly reasonable way to use documentation. If there's a dangerous gotcha and it isn't documented right there, then the documentation is structured badly.
> Or following an unofficial document
That could be a very clear symptom of bad documentation.
Sometimes it's on the user, but if lots of users are failing to use your documentation, maybe consider that the documentation is bad.