章12 测试文档

 章12 测试文档

软件产品由大量工作和为数不少的非软件部分组成，非软件部分主要是文档。
软件文档最常见的是拷贝到软件安装盘的readme文件。
软件测试员通常不限于仅测试软件，而要负责组成整个软件产品的各种部分。保证文档的正确性也在职责范围之内。
1、软件文档的类型
如果软件文档仅有readme文件，测试很简单。要保证该文档包含应有的所有材料，全部内容从技术角度讲准确无误，还要进行拼写检查和磁盘病毒扫描，这就是文档测试的内容。
现在，软件文档要占到整个产品的一大部分。
以下是可以归类于文档的软件组成部分。
（1）包装文字和图形
包括盒子、纸箱和包装纸。
文档困难包含软件的屏幕截图、功能列表、系统要求和版权信息。
（2）市场宣传材料、广告以及其它插页
（3）授权/注册登记表
这是客户注册软件时填写并寄回的卡片，也可以作为软件的一部分，显示在屏幕上让用户阅读、认可，并完成联机注册。
（4）EULA
代表最终用户许可协议。可能在软件安装过程中弹出显示在屏幕上。
（5）标签和不干胶条
可能出现在媒体、包装盒或者打印材料上。
它们还包括序列号不干胶条盒封EULA信封的标签。
（6）安装和设置指导
有时该信息直接打印在磁盘上。对于复杂软件，可以是完整的手册。
（7）用户手册。
主要是联机手册。
（8）联机帮助
联机帮助一般可以和用户手册互换使用，有时甚至取代用户手册。
联机帮助索引和搜索功能，用户查找所需信息更加容易。
（9）指南、向导和CBT（计算机基础训练）
这些工具将编程代码和书写文档融合在一起，一般是内容和类似宏的高级编程的混合体，通常捆绑在联机帮助系统中。
（10）样例、示例和模板
编译器可能用一小段代码来演示如何使用编程语言的某些方面。
（11）错误提示信息
2、文档测试的重要性
软件用户把这些独立的非软件部分当做整个软件的一部分。
好的软件文档以几种方式确保产品的整体质量：
（1）提高易用性
（2）提高可靠性
可靠性是指软件稳定和坚固的程度。
（3）降低支持费用
好的文档可以通过恰当的解释和引导用户解决困难来预防这种情况。
注意：作为软件测试员对待文档要像对待代码一样给予同等关注和投入。它们对用户是一样的。如果没有要求测试文档，一定要把此作为问题提出来并在整个测试计划中包括这部分。
3、审查文档时要找什么
测试文档有两个等级。
如果是非代码，测试就是静态过程，可以视之为技术编辑或技术校对。
如果是文档和代码紧密结合在一起，就要进行动态测试。这种情况属于真正的软件测试。
注意：无论文档是不是代码，像用户那样对待它都是非常有效的测试方法。
仔细阅读，按照每个步骤操作，检查每个图形，尝试每个示例。
如果有简单代码，测试代码是否按照描述的方式进行。
最后，如果文档是软件驱动的，就要像软件其余部分一样进行测试。
检查索引表是否完整，搜索结果是否正确，超级链接和热点是否跳转到正确的页面。利用等价划分技术确定尝试哪些测试用例。
4、文档测试的实质
（1）文档常常得不到足够的重视；
如果负责测试软件中的一个领域，一定要为伴随代码的文档测试做出预算，像对待软件一样给予关注。
（2）编写文档的人可能对软件做什么不甚了解；
文档作者不必是软件功能方面的专家。最重要的是，指出发现的代码中难以使用或者难以理解之处，让它们在文档中更好地解释。
（3）印刷文档制作要花不少时间，可能是几周，甚至几个月。
由于这个时间差，软件产品的文档需要在软件完成之前完稿——锁定。
5、总结
从用户的角度看，软件文档和软件都是同样的产品。联机帮助索引遗漏一个重要条目，安装指导中存在错误步骤，或者出现显眼的拼写错误，都属于与其它软件失败一样的软件缺陷。
如果正确地测试文档，就可以在用户使用之前发现这些缺陷。