全程软件测试（五十六）：软件测试项目的文档管理—读书笔记

软件测试项目整体来说其实是一个交互的过程，它涉及客户提供的需求文档、开发人员提供的设计文档。这些文档都是测试工程师进行测试的指导性文件，测试工程师应就上述文档与客户以及开发工程师进行深入、广泛的交流，争取就某些有争议的问题达成共识。同时应将上述交流内容以某种形式记录下来，在后期解决某些不明确的问题时，这是有效的证明资料。

测试工程师的测试 告、缺陷 告，开发工程师对相关缺陷所给出的解释以及双方就某些情况所做的交流都是很宝贵的信息，应尽可能地保存下来，以便给后面的测试工作提供借鉴。在特定项目过程中，解决问题的成功模式和方法可以系统地保留下来。

每个测试项目在执行的过程中都会产生大量文档，从项目启动前的计划书到项目结束后的测试总结 告，其间还会有产品需求、测试计划、测试用例和各种重要会议的会议记录等。

软件测试文档是将上述内容、测试要求、测试过程及测试结果以正式文件的形式写出，因此，编写测试文档是测试工作规范化的一个重要组成部分，将文档管理融入项目管理是非常有必要的，应将其设置为项目管理中很重要的一个环节。

文档管理所包含的主要内容有4个方面：文档的分类管理；文档的格式和模板管理；文档的一致性管理；文档的存储管理。

1.测试文档的分类管理

测试文档可简单地分为两类，分别是测试文档模板和测试过程中生成的文档。测试文档模板是对生成的文档的格式、内容做严格要求的示范文档。基本的测试文档模板有以下几种。

（1）测试计划文档模板。

（2）测试需求分析模板。

（3）测试用例模板。

（4）测试评审模板。

（5）测试 告模板。

同时，可按照输入媒介将测试文档分为电子文档、纸质文档和其他一些特殊文档。电子文档和纸质文档存储和管理的办法是不一样的，应区别对待。多数情况下，文档按照用途来划分，可以分为5类，具体如下所示。

（1）测试日常工作文档（流程定义、工作手册等）。

（2）测试培训文档和相关技术文档。

（3）测试计划、设计文档。

（4）测试跟踪、审查资料。

（5）测试结果分析 告或产品发布质量 告。

实际上，不论是作为测试小组还是作为测试部门，除了管理测试本身的文档，还应管理外部输入的文档和软件产品文档。外部输入的文档主要包括系统需求分析 告、设计规格说明书、项目计划书等；软件产品文档包括发布说明、用户手册、技术手册、安装说明、帮助文档等。

2.测试文档的存储和共享

众所周知，需要管理的测试文档有很多，我们一方面需要可靠地存储这些文档，另一方面又需要有效地、充分地利用这些文档，这两方面相辅相成，需要统一考虑。

若要做好测试文档的存储，事先应进行各种准备，从文档的分类、文件名的格式、文件的模板等方面严格要求测试文件的编制。文件名虽然是一个小问题，但文件名编写得不合理也会引起大量麻烦，因此，需要有明确的规定，要求文件名必须用英文，并包含测试组名、项目名、文件类型、日期等，具体示例如下，其中首字母T代表测试类文档。

T-Team Name-Project Name-Weekly Report-2004-3-08.doc

接下来应按照完整的模板逐条编写所需要的计划书、 告等。

文档存储方式要与如何使用此文档相结合，即根据测试文档的使用目的来进行文档存储的规划和设计。测试文档的使用可以分为个人使用、项目组内部使用和所有测试人员都需要使用，其存储也服务于上述对象，另外还要考虑具体的使用方法。对上述内容进行概括，文档存储的规划、设计需要考虑的因素如下。

（1）共享方式：共享目录、FTP方式、HTTP方式。

（2）手段：自己开发文档管理系统或借助第三方的商品化软件，如MicrosoftShare Point。

（3）安全性：测试文档一般都会涉及公司内部的机密信息，需要保证其安全性，严格设置相关用户的权限体系。

（4）目录结构：目录可按照团队、项目、文件类型的多层次关系进行设置。

（5）操作要灵活，包括存取、修改、阅读等各项操作。

3.文档模板

在项目进行软件测试时，有些文档是每个项目必备的，如测试计划书、测试用例、测试项目 告、质量分析 告等。对于上述经常使用的文档类型，可以把格式和内容统一起来，为每种类型的文档建立相对固定的模板。

建立模板便于文档的管理和分类，也让测试工程师比较容易编制、编写所需要的测试文档。整个开发团队的其他成员也对文档的格式非常熟悉，可直接查找自己最关心的部分，一目了然。

对于特定的项目，文档可酌情对模板中的条目进行增删。制定模板的初衷是方便整体工作，而不是禁锢思维，在完成具体工作时，一定要把原则性和灵活性掌握好。