关于项目文档不规范的思考.doc

《关于项目文档不规范的思考.doc》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、摘要在软件开发过程屮，经常听到说：某某项冃文档相当规范，某某项H文档相当不规范，那么，项H文档不规范常见的现象是什么呢？造成项冃文档不规范的原因又是什么呢？本文介绍“A项冃”的文档检查情况，一位资源的QA对检查的结果进行反思，总结项冃文档不规范的常见现象，分析其屮原因。案例背景“A项目”是一个项目群，涉及电子政务某方面业务的多个项冃，约有20个子项日，共有6支开发团队为子项目提供开发、维护工作。该项目具有两大特点：⑴、子项目数量较多，根据合同事数最计算，大大小小的子项目约二十个，毎个项目的规模都很小，只有两、三人；（2）、“A项目”周期很长，于1999年启动

2、，至今有8年，毎个子项目的周期很短，一般的只有一年时间，甚至不到一年或者只有半年。为加强项H文档规范，项H经理对QA提出要求，在三个月的时间内，对其中的6个子项H的文档进行严格检查，发现不一致性问题，并要求项日经理对不合格项及时进行整改。QA在检查文档的过程屮发现，有的文档编号、名称不规范，版木记录比较混乱，文档主体内容随意剪裁，标准文档模板使用张冠李戴，该写的文档没有写，很多文档没有进行流转审批等问题。案例分析通过这次集屮的、检查反馈出的问题，QA在思考，项H文档不规范问题主要有哪些常见的现象呢？造成这些情况的原因是什么呢？项目规范分为活动规范，文档规范，

3、与项目质最分为过程质昴:、产品质量互相呼应。一个是工作方式方法是否符合标准流程要求，一个是介质文档是否符合标准模板要求。然而在软件项目活动过程屮，软件项目、工程活动相对规范，但项目文档不规范相对严重，从而引起我们的思考：一、文档不规范的常见现象在软件开发过程中，不同公司的质最体系、不同项!■!的质最要求不同，文档不规范各不相同，它与公司质最标准、项目质最要求紧密相连，项日文档不规范常见的现象如下：1.项H编号、项FI命名不规范。同一个项!■!编号不同。有时一个项H有一个甚至多个编号，如：某项日编号有时使用YKSX,有时使用YKSX（TL）。同一个项H名称不同

4、。项目名称包括有：项H简称、项日全称，如：它的简称有时命名“XX工程项H”，有时命名“XX信息系统”：它的全称有时命名为“上海市XX信息管理系统”，有时命名为“XX工程项冃信息管理系统”。无论是项冃编号，还是项日名称（项冃简称、项冃全称），每个项目都有一个统一的编号、简称、全称。2.文档编号、文档命名不规范。每份文档都有一个编号,如某项目文档编号由WD_PA_PRO_YYMMDD_姓名拼写组成，其中WD表示公司名称,PA表示项冃编号，I氓0表示文档类型、此处指的是项H过程书，YYMMDI）表示日期，姓名拼写表示姓名的拼音三个字母组成，不足三位的补“X”或“Y

5、”。而在使用过程屮，有的不知道PA是表示项目编号，有的日期格式写成YYYY-MM.DD,有的随意增加其它内容。文档命名通常山编号与文档类型名称组成，如项目过程书文档规范的命名是"WD_PA_PRO_YYMMDD_姓名拼写项目过程书”。1.文档页眉、页脚不规范一般正规的文档，页眉页脚大都使用公司的Logo或公司的简称,它是公司的标志，也说明这一份文档不仅是代表项目纽，也是代表公司的形象。而页眉、页脚上的logo或标志应该是固定的，项目纽不应该随意:性修改。2.文档的版木标识不规范根据配置管理的定义，文档控制级别为中、低的文档是不需要进行版木控制的，比如那些一些

6、临时性的、一次性的、屮间性的文档，而文档控制级别较高的文档要进行版木管理。在一些控制级别的文档中，如：用户需求说明书，概要设计说明书等，无论修改有多少次，没有留下版本记录。有的文档标识有版木记录,一个版本对应一份文档，比如《用户需求说明书V1.0.doc》、《用户需求说明书VI.l.doc》等,这样维护文档容易出错。3.文档主体的裁剪、榕式不规范与标准文档模板相比较，项目文档主体内容裁剪不规范，随意性增加或删除文档目录的内容，如：标准模板上主体内容有5章，而项目文档经过裁剪后只写3章,或者是写6章,増加一章的内容。对于文档格式，大都是不完全遵循标准文档模板。

7、4.文档审核意见没有签名批复在项日文档屮，大部分文档结尾部分都有相关人员的签名审批，文档在流转过程中有相关的干系人阅读,如果他们没有意见则同意签名，这是对文档进行走查、验证管理的一个重要证据，也是对项冃文档质最进行控制的一个朿要手段。虽然如此，但很少人对阅读这样的文档后进行签名批复，或者是口头指出意见,或是邮件冋得提出问题，但最终的结果是，从项H文档本身是无法看到签名批复的，既没有书面形式的，更没有电子签名的。5.模板使用不规范在项目不同阶段，每个阶段要产生哪些类型文档，基本上固定的。如需求阶段要产生《调研报告》、《用户需求说明书》、《需求确认书》。而不规范

8、命名如：在试运行试阶段，用于规划、指导试运的文档，质