摘要

在软件开发过程中，经常听到说：某某项目文档相当规范，某某项目文档相当不规范，那么，项目文档不规范常见的现象是什么呢？造成项目文档不规范的原因又是什么呢？本文介绍“A项目”的文档检查情况，一位资源的QA对检查的结果进行反思，总结项目文档不规范的常见现象，分析其中原因。

案例背景

“A项目”是一个项目群，涉及电子政务某方面业务的多个项目，约有20个子项目，共有6支开发团队为子项目提供开发、维护工作。该项目具有两大特点：(1)、子项目数量较多，根据合同事数量计算，大大小小的子项目约二十个，每个项目的规模都很小，只有两、三人 ；(2)、“A项目”周期很长，于1999年启动，至今有8年，每个子项目的周期很短，一般的只有一年时间，甚至不到一年或者只有半年。

为加强项目文档规范，项目经理对QA提出要求，在三个月的时间内，对其中的6个子项目的文档进行严格检查，发现不一致性问题，并要求项目经理对不合格项及时进行整改。QA在检查文档的过程中发现，有的文档编号、名称不规范，版本记录比较混乱，文档主体内容随意剪裁，标准文档模板使用张冠李戴，该写的文档没有写，很多文档没有进行流转审批等问题。

案例分析

通过这次集中的、检查反馈出的问题，QA在思考，项目文档不规范问题主要有哪些常见的现象呢？造成这些情况的原因是什么呢？

项目规范分为活动规范，文档规范，与项目质量分为过程质量、产品质量互相呼应。一个是工作方式方法是否符合标准流程要求，一个是介质文档是否符合标准模板要求。然而在软件项目活动过程中，软件项目、工程活动相对规范，但项目文档不规范相对严重，从而引起我们的思考：

一、 文档不规范的常见现象

在软件开发过程中，不同公司的质量体系、不同项目的质量要求不同，文档不规范各不相同，它与公司质量标准、项目质量要求紧密相连，项目文档不规范常见的现象如下：

1.项目编号、项目命名不规范。

同一个项目编号不同。有时一个项目有一个甚至多个编号，如：某项目编号有时使用YKSX，有时使用YKSX(TL)。

同一个项目名称不同。项目名称包括有：项目简称、项目全称，如：它的简称有时命名“XX工程项目”，有时命名“XX信息系统” ；它的全称有时命名为“上海市XX信息管理系统”，有时命名为“XX工程项目信息管理系统”。

无论是项目编号，还是项目名称(项目简称、项目全称)，每个项目都有一个统一的编号、简称、全称。

2.文档编号、文档命名不规范。

每份文档都有一个编号，如某项目文档编号由WD_PA_PRO_YYMMDD_姓名拼写组成，其中WD表示公司名称，PA表示项目编号，PRO表示文档类型、此处指的是项目过程书，YYMMDD表示日期，姓名拼写表示姓名的拼音三个字母组成，不足三位的补“X”或“Y”。而在使用过程中，有的不知道PA是表示项目编号，有的日期格式写成YYYY-MM_DD，有的随意增加其它内容。文档命名通常由编号与文档类型名称组成，如项目过程书文档规范的命名是“WD_PA_PRO_YYMMDD_姓名拼写 项目过程书”。

3.文档页眉、页脚不规范

一般正规的文档，页眉页脚大都使用公司的Logo或公司的简称，它是公司的标志，也说明这一份文档不仅是代表项目组，也是代表公司的形象。而页眉、页脚上的logo或标志应该是固定的，项目组不应该随意性修改。

4.文档的版本标识不规范

根据配置管理的定义，文档控制级别为中、低的文档是不需要进行版本控制的，比如那些一些临时性的、一次性的、中间性的文档，而文档控制级别较高的文档要进行版本管理。在一些控制级别的文档中，如：用户需求说明书，概要设计说明书等，无论修改有多少次，没有留下版本记录。有的文档标识有版本记录，一个版本对应一份文档，比如《用户需求说明书V1.0.doc》、《用户需求说明书V1.1.doc》等，这样维护文档容易出错。

5.文档主体的裁剪、格式不规范

与标准文档模板相比较，项目文档主体内容裁剪不规范，随意性增加或删除文档目录的内容，如：标准模板上主体内容有5章，而项目文档经过裁剪后只写3章，或者是写6章，增加一章的内容。对于文档格式，大都是不完全遵循标准文档模板。

6.文档审核意见没有签名批复

在项目文档中，大部分文档结尾部分都有相关人员的签名审批，文档在流转过程中有相关的干系人阅读，如果他们没有意见则同意签名，这是对文档进行走查、验证管理的一个重要证据，也是对项目文档质量进行控制的一个重要手段。虽然如此，但很少人对阅读这样的文档后进行签名批复，或者是口头指出意见，或是邮件回得提出问题，但最终的结果是，从项目文档本身是无法看到签名批复的，既没有书面形式的，更没有电子签名的。

7.模板使用不规范

在项目不同阶段，每个阶段要产生哪些类型文档，基本上固定的。如需求阶段要产生《调研报告》、《用户需求说明书》、《需求确认书》。而不规范命名如：在试运行试阶段，用于规划、指导试运的文档，质量体系称为《试运行计划》，而在使用时将它命名为《项目实施试运行方案》。如汇总所有调研内容的文档是《用户需求说明书》，而项目经理有时却将它命名为《用户需求调研报告》。

8.文档的位置存放不正确

为便于文档管理，项目都建立了一个个文件夹，将相关的文档分别放置在不同的文件夹下。

有的将《项目建议方案》放在项目启动目录下，有的将《需求变更单》放在系统维护目录，其实上，无论放在哪里都是没有错的，但它不符合规范，同时也不利于文档的使用，间接影响了项目。

9.该写的文档不写

开会没有《会议纪要》，会上发言承诺信誓旦旦，会后忙碌全抛脑后 ；沟通交流没有备忘录，需求变更、系统问题没有记录，过后问题弄不清楚 ；下达命令没有计划，安排工作排脑袋。对于项目活动不规范，直接影响文档不规范，那就是没有此文档。

二、 文档不规范的原因分析

缺乏奖惩措施，当项目文档规范时，缺少奖励，如：口头鼓励，通报表扬，增加奖金 ；当项目文档不规范时，没有相应的惩罚措施，如：通报批评，扣除奖金。在一些外资大型IT公司，在项目实施规范的奖惩方案中，项目经理、质量经理共同掌握团队成员奖金的分配权，项目经理对团队成员70%的奖金拥分配权，质量经理对团队成员30%的奖金拥有分配权，当项目不规范时，质量经理可以进行权限范围内的奖惩。

对项目文档的作用认识理解不够。只要客户满意，系统稳定、功能健全，项目文档作用不太，主是依靠正在使用的系统，及客户的满意度。对项目文档的规范认识理解不够。在软件开发过程中，信息的传递主要是依据面对面沟通、系统演示等方式进行交流为主，以文档介质交流为辅，项目文档是否规范也就无所谓。

项目经理或项目组成员不熟悉规范，不知道规范的文档应该是什么样子。在实施过程中，因为他不清楚，又不想办法进行咨询，而是根据个人工作经验，或掌握资源进行项目文档工作。

其它。

三、 项目文档规范的作用意义

项目文档是过程活动的终极成果，也是产品系统的过程文档，它是客户想法与最终产品的桥梁、中介文档。通俗说，项目的用户需求说明书，它是软件开发的依据 ；项目的需求变更单、系统问题维护记录单，它是需求变更、系统修改的凭证 ；项目文档是项目相关信息、凭证、经验等的载体，它的意义很广。从项目组的角度出发，项目文档规范的主要意义包括：

通过客户审计。政府IT项目大都有审计部门，如果项目文档不规范，很难通过客户的审计，如果审计通不过，往往要求返工，或是验收通不过。

通过第三方监理。随着信息化建设不断加强，信息监理不断深入，如果项目文档不规范，通不过第三方监理。类似这样的还包括专家验收、第三方测试等。

项目实施规范可以促进项目文档规范，有规范的活动就形成规范的工作成果，反过来，项目文档规范可以促进项目实施规范。

项目文档规范，为以后的开发、维护工作奠定良好的工作基础。

项目文档与产品文档的意义与区别，产品文档具有反复重用性，而项目文档具有一次性特征。

小结

在客户对文档命名没有特别要求的情况下，应严格按公司规范执行，而不仅是项目经理、项目团队的个人理解或认识。

在项目文档审批流转过程中，有人认为那是走形式，与其说是走形式，倒不如认为是走流程，走流程是按规范办事的一种表现。在文档流转过程中，每个人要做好本职工作，如果流程有问题，则由提交给流程改进人员改进，而不能因为流程不好而放弃，这样既让流程改进人员错过一次改进的机会，同时又滋长个人不按规范办事的行为。