3 ms·
> What black magic do you have to cast to get devs to look at the documentation? That's not how documentation works (in my experience). Ignoring documentation
by dakiol 3y ago
> What black magic do you have to cast to get devs to look at the documentation?
That's not how documentation works (in my experience). Ignoring documentation is fine (perhaps I don't need documentation to get things done?). The problem is having the need of documentation and find that none exists; that's the real issue. If there's no documentation, as an engineer I have 2 options: a) read the codebase, b) ask around. Whatever option takes less time and is more accurate wins (and take into account that the code may contains bugs, so the code is not always a reflection of the intended business use cases... on the other hand no-one may know what the codebase is supposed to do).
Documentation is like having a fire extinguisher: hopefully you won't need it most of the time, but if in that single occasion that you need it you find none, well, imagine.
- lordnacho 3y agoIt's not just whether it exists though. Too much documentation is a thing as well. In a way it's worse, because the reader can't find the thing they are looking for, but the author can always point at where it is when asked. So then the author becomes the index and wonders why they keep getting asked.