论文标题
超越准确性：评估软件文档质量
Beyond Accuracy: Assessing Software Documentation Quality
论文作者
论文摘要
良好的软件文档鼓励了良好的软件工程，但是“良好”文档的含义在软件工程文献中隐约定义了。为了澄清这种歧义，我们借鉴了数据和信息质量社区的工作，以提出一个将文档质量分解为结构，内容和样式的十个维度的框架。为了证明其应用，我们在评估几种软件文档类型的示例时招募了技术编辑来应用该框架。我们总结了他们的评估 - 例如，参考文档和读书文件在质量上表现出色，而博客文章则有更多问题 - 我们描述了我们对软件文档质量的推理以及统一质量框架的扩展和潜力的愿景。
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.
