Documentation is the Warning: Moose Sign Ahead of digital highways. They should write a sequel to "Traffic" on the sins of software development.
In the best case, documentation simply mirrors the same expectations of usage one receives from public API type signatures. A form of duplication. In the worst case, documentation straight up lies, is outdated, misleading, distracts from improving the software, points directly to the parts of the system with overly convoluted design. Good product has users discarding manuals without ever having read them.
1 comment
[ 0.21 ms ] story [ 13.8 ms ] threadIn the best case, documentation simply mirrors the same expectations of usage one receives from public API type signatures. A form of duplication. In the worst case, documentation straight up lies, is outdated, misleading, distracts from improving the software, points directly to the parts of the system with overly convoluted design. Good product has users discarding manuals without ever having read them.