Beyond Accuracy: Assessing Software Documentation Quality
| Autor: | Thushari Atapattu, Christoph Treude, Justin Middleton |
|---|---|
| Jazyk: | angličtina |
| Rok vydání: | 2020 |
| Předmět: |
Structure (mathematical logic)
FOS: Computer and information sciences Software documentation Computer science business.industry media_common.quotation_subject Information quality 020207 software engineering 02 engineering and technology Ambiguity Software Engineering (cs.SE) Computer Science - Software Engineering Documentation 020204 information systems README 0202 electrical engineering electronic engineering information engineering Quality (business) Software engineering business media_common Meaning (linguistics) |
| Zdroj: | ESEC/SIGSOFT FSE |
| Popis: | 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. to appear in the Visions and Reflections Track of the ACM Joint European Software Engineering Conference and Symposium on the Foundations of Software Engineering 2020 |
| Databáze: | OpenAIRE |
| Externí odkaz: |
|