软件文档质量评价方法研究

陈琪 葛志松 许骏龙

摘要：随着软件开发工程化的发展，人们已经注意到开发文档是软件产品的重要组成部分，软件文档质量的好坏直接影响到软件的开发、使用和维护。在相关软件测试标准中，已将文档审查列为一种正式的测试类型，但是相较于传统的测试类型，文档测评还没有形成较为系统、形式化的方法。基于此，该文提出一种适用于软件文档质量评价的综合方法。

关键词：软件文档；质量评价；评价模型

中图分类号：TP311 文献标识码：A 文章编号：1009-3044（2018）30-0060-02

1 概述

文档测评范围应根据上级要求、测评任务书、合同或其他等效文件综合确定，一般包括被测软件需求规格说明、设计说明、用户手册等。文档测试与程序测试有很大不同，文档是不可运行的。经过长期试验，笔者认为比较有效的文档测试方法主要分为两类：审查，参照编写依据阅读文档，与同一系列或相关软件文档产品相对比；验证，文档与程序运行情况相比对。

在实际工作中，文档审查工作经常在软件测试之前实施，基于人力资源有限，文档验证通常由测试人员在测试工作中同步实施，发现的问题通常会归类到软件问题。在该文中文档质量评价适用于文档审查方法。

2 文档质量模型

在GJB5236-2004《软件质量度量》中适用于文档质量度量是“易用性”和“可维护性”2个质量特性中的部分子特性，但这2个质量特性的评价对象还包括可执行程序，且“易用性”以最终用户为评价者，增大了评价实施的复杂度，因此必须建立适合文档特点的质量度量模型。

在该文中，参考GJB5236-2004《军用软件质量度量》的质量度量框架将文档质量归纳为4个质量特性：完整性、一致性、准确性和规范性；结合最新的文档评估国际标准[1][2]、GJB438-88《军用软件文档编制规范》[3]、GJB438A-97《武器软件开发文档》[4]等工程化标准，将质量特性进一步细分为若干个度量，规定了度量准则，形成了一个文档质量度量模型。

2.1 完整性度量

完整性度量指文档产品为指定的软件和功能提供完整说明的能力。

2.1.1 一致性度量

一致性度量指文档内部和文档之间说明的一致性能力。

2.1.2 正确性度量

2.1.3 规范性度量

3 文档质量评价模型

文档质量评价模型由文档质量要素评价、单个文档质量评价和文档质量综合评价3级评价体系结构组成，如图1所示。 图中实线表示组成关系，虚线箭头表示评价过程。

文档审查是基于评审组的测评方式，并依据通过认可的文档审查单对文档进行审查和打分。在此基础上依据文档问题和专家打分情况对文档质量进行评价。

3.1 文档质量要素评价

文档质量要素评价，是指对组成文档质量的各项要素进行评价。质量要素基于度量元，结合文档类型、文档所依据的国家及军用标准要求及测试要求确定。质量要素确定后，需根据质量要素要求分类制定详细的文档审查内容，形成审查单，审查单需通过评审确认。

文档质量要素评价完成后，需根据文档质量要素所属的度量元评价结果计算每个度量元的度量结果。

3.2 单个文档质量评价

依据每个度量元的结果计算所属质量特性的结果。

3.3 文档综合质量评价

根据单个文档质量评价结果，计算软件文档质量的综合质量结果。

3.4 计算公式

对文档质量进行评价时，每一级都需考虑其下级各质量因素的权重，因此通用的文档质量评价结果计算公式如下：

3.5 权值计算方法

AHP是一种被广泛应用的决策方法，适用于建立了层次机构的评价模型，它可以更好地对专家经验进行处理，使得权重值的确定结果更加合理。但该方法依赖于数据的长期积累，且实施时计算量较大，因此，该方法适用于数据积累到一定程度且时间比较充裕的评价过程。该文中主要选用AHP中的判断矩阵构造和权重向量求解方法。

参考文献：

[1] ISO-IEC， ISO-IEC_26513_（E）. Software and systems engineering — Requirements for assessors and testers of user documentation[Z]. ISO-IEC， 2007.

[2] ISO-IEC， ISO/IEC25051. Software engineering – Software product Quality Requirements and Evaluation （SQuaRE） – Requirements for quality of Commercial Off-The-Self （COTS） software product and instructions for testing[Z]. ISO-IEC， 2006.

[3] 总装备部， GJB 438-88. 軍用软件文档编制规范[Z]. 北京： 总装备部， 1988.

[4] 总装备部， GJB 438A-97. 武器软件开发文档[Z]. 北京： 总装备部， 1997.

【通联编辑：谢媛媛】