《软件测试》第十二章文档测试

12.0 前言
12.1 软件文档的类型
12.2 文档测试的重要性
12.3 审查文档时要找什么
12.4 文档测试的实质

12.0 前言

本章讲述测试软件文档的技术，以及如何在整个软件测试工作中将其包含在内。本章重点包括：

软件文档的不同类型
文档测试为什么重要
在测试文档时要找什么

12.1 软件文档的类型

如果软件文档除了简单的readme文件再没有其他内容，测试倒不是什么大事。要保证该文档包含应有的所有材料，全部内容从技术角度讲准确无误，还要进行拼写检查和磁盘病毒扫描（为了得到好的评价），这就是文档测试的内容。但是，文档仅仅由readme文件组成的日子已经一去不复返了。

以下是可以归类于文档的软件组成部分。显然，每一个软件不一定非要有所有这些部分不可，但是可能会有：

包装文字和图形。包括盒子、纸箱和包装纸。文档可能包含软件的屏幕抓图、功能列表、系统要求和版权信息。
市场宣传材料、广告以及其他插页。这些常常是人们随手丢弃的纸，但是它们是用于促进相关软件销售的重要工具，同时提供补充内容和服务联系方式等。对于严肃对待它们的客户而言，这些信息必须正确。
授权/注册登记表。这是客户注册软件时填写并寄回的卡片，也可以作为软件的一部分，显示在屏幕上让用户阅读、认可，并完成联机注册。
EULA。代表最终用户许可协议。这是要客户同意条款的法律文书，其中要求用户同意不得复制软件，如果受到软件缺陷的侵害，也不得向生产厂商起诉。EULA有时打印在装有电子媒体——软盘或者光盘的信封上。它也可能在软件安装过程中弹出显示在屏幕上。
标签和不干胶条。它们可能出现在媒体、包装盒或者打印材料上。它们还包括序列号不干胶条和封EULA信封的胶条。
安装和设置指导。
用户手册。
联机帮助。
指南、向导和CBT（计算机基础训练）。这些工具将编程代码和书写文档融合在一起。它们一般是内容和类似宏的高级编程的混合体，通常捆绑在联机帮助系统中。用户可以提出问题，然后由软件一步步引导完成任务。
样例、示例和模板。
错误提示信息。

12.2 文档测试的重要性

如果安装指导有误，或者不正确的错误提示信息把用户引入歧途，他们就会认为这是软件缺陷——软件测试员应该发现这些问题。

好的软件文档以下述3种方式确保产品的整体质量：

提高易用性。
提高可靠性。可靠性是指软件稳定和坚固的程度。软件是否按照用户预期的方式和时间工作？如果用户阅读文档，然后使用软件，最终得不到预期的结果，这就是可靠性差。
降低支持费用。

作为软件测试员对待软件文档要像对待代码一样给予同等关注和投入。它们对于用户是一样的。如果没有要求测试文档，一定要把此作为问题提出来并在整个测试计划中包括这部分。

12.3 审查文档时要找什么

测试文档有两个等级。如果是非代码，例如打印的用户手册或者包装盒，测试就是与第四章“检查产品说明书”和第六章“检查代码”所述类似的静态过程。可以视之为技术编辑或技术校对。如果文档和代码紧密结合在一起，例如超级链接的联机手册或者提供帮助的剪纸朋友，就要进行动态测试，利用第五章“带上眼罩测试软件”和第七章“带上X光眼镜测试软件”的技术进行检查。这种情况属于真正的软件测试。

无论文档是不是代码，像用户那样对待它都是非常有效的测试方法。仔细阅读，按照每个步骤操作，检查每个图形，尝试每个示例。如果有简单的代码，测试代码是否按照描述的方式运行。利用这个现实的简便方法，可以找出软件和文档的缺陷。

下表是构建文档测试用例基础的简化检查清单：

最后，如果文档是软件驱动的，就要像软件其余部分一样进行测试。检查索引表是否完整，搜索结果是否正确。超级链接和热点是否跳转到正确的页面。利用等价划分技术确定尝试哪些测试用例。

12.4 文档测试的实质

以下问题可以称作文档测试的实质：

文档常常得不到足够的重视、预算和援助。如果负责测试软件中的一个领域，一定要为伴随代码的文档测试做出预算，像对待软件一样给予关注，如果发现软件缺陷，就报告出来。
编写文档的人可能对软件做什么不甚了解。与文档作者密切合作，以保证文档包含所需信息，并随着产品设计更新。最重要的是，指出发现的代码中难以使用或者难以理解之处，让他们在文档中更好地解释。
印刷文档制作需要花不少时间，可能是几周，甚至几个月。由于这个时间差，软件产品的文档需要在软件完成之前完稿——锁定。如果在这个关键时期改变了软件的功能或者发现了软件缺陷，那么文档将无法反映更改，这正是发明readme文件的原因——它是将最后改动通知用户的方式。该问题的解决方法是找一个好的开发模式来遵循。是文档保持到最后一刻发布，并且以电子格式随软件一起发布尽可能多的文档。