Beyond accuracy: Assessing software documentation quality

Abstract

Good software documentation encourages good software engineering, but the meaning of “good” documentation is vaguely defined in the software engineering literature. To clarify this ambiguity, we draw on work from the data and information quality community to propose a framework that decomposes documentation quality into ten dimensions of structure, content, and style. To demonstrate its application, we recruited technical editors to apply the framework when evaluating examples from several genres of software documentation. We summarise their assessments—for example, reference documentation and README files excel in quality whereas blog articles have more problems—and we describe our vision for reasoning about software documentation quality and for the expansion and potential of a unified quality framework.