阐述一个公司文档管理的重要性

1          概述

文档测试规范作为后续项目的重要产出物，除提供涉及功能服务外，同时需要配套相应文档，且文档必须测试通过。

2   目的

规范管理文档，让文档成为标准化的工具。

1、指导新进员工快速接手工作，防止技术流失。

2、让文档成为唯一约束，尤其是集成项目，多服务器配置部署必须达成一致。

3、好的文档能达到提高易用性、提高可靠性、降低技术支持费用的目的，从而提高了产品的整

体质量。用户通过文档可以掌握具体的使用方法，这提高了产品的易用性，避免了用户在摸索

使用中一些不可预期的操作，也就相对避免了一些不可预期的错误的发生，从而提高了产品的

可靠性。

4、文档在软件开发人员，软件管理人员，维护人员，软件测试人员以及计算机之间起到了多种

桥梁作用。软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据，

这个作用是显而易见的。软件开发过程中软件开发人员需制定一些工作计划或工作报告，这些

计划和报告都要提供给管理人员，并得到必要的支持。管理人员则可通过这些文档了解软件开

发项目安排，进度，资源使用和成果等。软件开发人员需为用户了解软件的使用，操作和维护

提供详细的资料，我们称此为用户文档。

3          角色及职责定义

1)     产品：根据文档规范，负责需求文档的编写和维护工作。

2)     研发：根据文档规范，负责操作文档和研发项目文档的编写和维护工作。

3)     测试：根据文档规范，负责测试项目文档的编写和维护工作。

      根据文档规范，负责对需求文档、操作文档和测试项目文档的测试工作。

4          文档收集和归类

文档测试分为三大类：

需求文档：

1)     软件需求说明书（也称软件规格说明书，其中对所开发软件的功能，性能，用户界面

及运行环境等作出详细的说明。它是用户与开发人员双方对软件需求取得共同理解

基础上达成的协议，也是实施开发工作的基础）。

操作文档：

1)     软件安装文档

2)     系统部署文档

项目文档：

1)     研发项目文档：

a)     项目开发计划（为软件项目实施方案制定出具体计划，应该包括各部分工作的负责人

员，开发的进度，开发经费的预算，所需的硬件及软件资源等。项目

开发计划应提供给管理部门，并作为开发阶段评审的参考）。

b)     开发进度月报（及时向有关管理部门汇报项目开发的进展和情况，以便及时发现或处

理开发过程中的问题。一般地，开发进度月报以项目组为单位每月编

写的。如果被开发的软件系统规模比较大，整个工程项目被划分给若

干个分项目组分担，开发进度月报以项目组为单位按月编写）。

c)     开发总结报告（总结本软件的开发经验和总结所学到的知识，以及对一个系统的大型

的软件设计的总体感悟，并将软件设计过程中遇到的问题加以阐述和

说明）。

d)     数据库设计说明书（该说明书是对于设计中的数据库的所有标识．逻辑结构和物理结

构做出具体的设计规定）。

e)     概要设计说明书（该说明书是概要设计阶段的工作成果，它应说明功能分配，模块划

分，程序的总体结构，输入输出以及接口设计，运行设计，数据结

构设计和出错处理设计等，为详细设计奠定基础）。

f)      详细设计说明书（着重描述每一模块是怎样实现的，包括实现算法，逻辑流程等）。

g)     可行性研究报告（说明该软件开发项目的实现在技术上，经济上和社会因素上的可行

性，评述为了合理地达到开发目标可供选择的各种可能实施的方案，

说明并论证所选定实施方案的理由）。

2)     测试项目文档：

a)     测试计划（描述了要进行的测试活动的范围、方法、资源和进度的文档；是对整个信

息系统应用软件组装测试和确认测试。文档中确定测试项、被测特性、测

试任务、谁执行任务、各种可能的风险）。

b)     测试报告（把测试的过程和结果写成文档，对发现的问题和缺陷进行分析，为纠正软

件的存在的质量问题提供依据，同时为软件验收和交付打下基础）。

c)     测试用例（指对一项特定的软件产品进行测试任务的描述，体现测试方案、方法、技

术和策略。内容包括测试目标，测试环境，输入数据，测试步骤，预期结

果，测试脚本等并形成文档）。

4.1  文档测试边界

4.1.1 需求文档

1)     准确地按照文档的描述使用软件。

2)     尝试每一个功能点。

3)     检查每条陈述。

4)     查找容易误导用户的内容。

4.1.2 操作文档

微信扫描二维码查看更多资讯！