目录

​编辑 

一、软件文档的分类

 1.1 开发文档

 1.2 产品文档

 1.3 管理文档

 二、文档质量等级划分

 2.1 1级文档

 2.2 内部文档(2级)

 2.3 工作文档（3级）

 2.4 正式文档（4级）

 三、配置管理

 3.1 配置管理的定义

 3.2 配置管理的6个主要活动

 1）制定配置管理计划

 2）配置标识

 3）配置控制

 4）配置状态报告

 5）配置审计

 6）发布管理和交付

 3.3 配置项

 3.3.1 配置项内容

 3.3.2 基线配置项

 3.3.3 非基线配置项

 四、文档管理的常见问题

 4.1 文件资料存储繁杂，分散难管理

 4.2 信息传达不对称、协同办公不畅通

 4.3 流程审批过程繁琐

 4.4 文件修改多次，无法辨别正确版本

 4.5 重要文件被修改，责任追不到人

 五、文档管理的价值

 5.1 知识沉淀

 5.2 成果验收

 5.3 质量控制

 5.4 知识安全

---

一、软件文档的分类

 1.1 开发文档

描述开发过程本身，包括了可行性研究报告和项目任务书；需求规格说明；功能规格说明；设计规格说明，包括程序和数据规格说明；开发计划；软件集成和测试计划；质量保证计划；安全和测试信息。

 1.2 产品文档

描述开发过程的产物；包括了培训手册；参考手册和用户指南；软件支持手册；产品手册和信息广告。

 1.3 管理文档

记录项目管理的信息，包括了开发过程的每个阶段的进度和进度变更的记录；软件变更情况的记录；开发团队的职责定义；项目计划、项目阶段报告；配置管理计划。

 二、文档质量等级划分

 2.1 1级文档

适合开发工作量低于一个人月的开发者自用程序。该文档应包含程序清单、开发记录、测试数据和程序简介。

 2.2 内部文档(2级)

可用于没有于其他用户共享资源的专用程序，2级文档还包括程序清单内足够的注释以帮助用户安装和使用程序。

 2.3 工作文档（3级）

适合于由同一单位内若干人联合开发的程序，或可被其他单位使用的程序。

 2.4 正式文档（4级）

适合那些要正式发行供普遍使用的软件产品，关键性程序或具有重复管理应用性质（如工资计算）的程序需要4级文档。4级文档遵守GB/T8567-2006。

 三、配置管理

 3.1 配置管理的定义

配置管理正式定义为：应用技术的和管理的指导和监控方法以识别和说明配置项的功能和物理特征，控制这些特征的变更、记录和报告变更处理过程和实现状态并验证与规定的需求的遵循性。

软件配置管理：它是关于软件资产的管理，什么是软件资产呢，源代码、设计文档等文档，可以运行的程序、自动测试脚本、编译器等工具和环境......所有在软件开发过程中使用的或产生的，有价值的值得保存的东西，都是软件资产。软件配置管理它就是关于这些内容的管理。

 3.2 配置管理的6个主要活动

 1）制定配置管理计划

写一个文档，叫配置管理计划，规定如何做好配置管理

 2）配置标识

识别出需要把哪些东西作为配置项来管理

 3）配置控制

配置项有一些变更，需要做好配置项的变更控制

 4）配置状态报告

需要报告配置项的状态是什么样的

 5）配置审计

做好审计，看有哪些好的，哪些不好的经验教训，效果怎么样

 6）发布管理和交付

注意发布和交付过程，妥善保存好代码和文档的母拷贝

 3.3 配置项

 3.3.1 配置项内容

1）项目计划书

2）需求文档

3）设计文档

4）源代码

5）可执行代码

6）测试用例

7）运行软件所需的各种数据

以上配置项经评审和检查通过后进入配置管理。

有些文档生成后不可修改的（如测量报告、会议纪要、工作报告），就不能当做配置项，配置项是可以修改的。

 3.3.2 基线配置项

包括所有的设计文档和源程序等

 3.3.3 非基线配置项

包括项目的各类计划和报告等

所有配置项的操作权限都由CMO（配置管理员）严格管理，基本原则是：基线配置项向开发人员开放读取的权限；非基线配置项向PM、CCB（控制变更委员会）及相关人员开放。

 四、文档管理的常见问题

 4.1 文件资料存储繁杂，分散难管理

大量的项目文档，要么存储在不同人员的不同电脑里，要么存储在服务器中各个人员“任性”创建的文件夹里，缺乏统一存储和分类，存在丢失、损坏的隐患。

 4.2 信息传达不对称、协同办公不畅通

项目人员众多，办公地点分散，文件存储方式繁多，涉及各个办公人员之间的协作，信息获取较为不便，无法实现协同高效办公，导致项目推进遇阻，影响项目进度。

 4.3 流程审批过程繁琐

使用传统的纸质流程，或者PC端线上审批流程，审批节点冗长而繁复，完成一个流程的审批需花费大量时间，未能及时获得审批信息，导致延误工期，造成损失。

 4.4 文件修改多次，无法辨别正确版本

文件进行校阅、修改后，文件版本混乱，无法区分最新版本，一旦看错文件，可能会给项目带来不可挽回的损失。

 4.5 重要文件被修改，责任追不到人

为什么文件会被不知名的人员修改？为什么被改之后却找不到责任人？缺乏文档权限管理，让文档失去安全保护；而没有文档操作记录，又无法追究到责任人。

 五、文档管理的价值

作为一个项目的管理者，当遇到上述经历时，有效的项目文档管理就是解决上述问题的最佳方案。

项目文档管理在一个项目中具备非常多的价值，包括有：

 5.1 知识沉淀

避免员工离职，项目进度受影响；信息的传递，可为后期的项目决策提供借鉴。

 5.2 成果验收

项目文档作为项目交付物，是项目验收的依据，形成闭环。特别是研发类项目，最后的交付物一般为设计图纸等文档。

 5.3 质量控制

特别是在高端制造行业，对项目质量的要求比较严格，需要通过项目文档控制任务完成。

 5.4 知识安全

保护文档隐私，避免信息泄露。比如，在军工行业，对重要的项目文档需要进行加密设置，对权限的设置更加严格。

如果觉得本文对您有帮助，欢迎点赞+关注！