6 December 2021 by Phillip JohnstonBoth developers and researchers know that documentation is a real problem. Documentation is often considered a “dirty word” because it’s very often bad, and bad documentation gets ignored, leading to software aging. It’s reasonable to ask, “What makes bad documentation?” Documentation is bad if any of the following are true: Information is not available Information is incomplete Information is not correct Information is hard to find (poorly organized) Information is duplicated and possibly inconsistent Information is imprecise, easily misinterpreted The documentation is bulky Documents are not kept “alive” Documentation was written by people who do …
Continue reading “What Makes Bad Documentation”
To access this content, you must purchase a Membership - check out the different options here. If you're a member, log in.