产品开发项目文档管理规范V3.0

产品开发项目文档管

理规范V3.0

目录

1概述...............1

1.1目的....................................1

1.2适用范围...................................1

2产品开发文档体系..............................................................1

3文档质量的度量准则...........................—.3

4主要角色和职责................................................................4

4.1文档作者...............................................................4

4.2项目经理...............................................................4

4.3PPQA.............................................................................................................5

4.4配置管理工程师.........................................................5

|•••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••••3

4.6部门经理……..........................................................5

5文档审核流程...................................5

5.1审核流程..............................................................6

5.2归档签名..............................................................7

5.3纳入基线...............................................................8

6文档保密制度................................................................8

7文档编号......................................................................9

7.1文档编号规则...........................................................9

7.2阶段代号................................................................9

8文档版本.....................................................

1概述

1.1目的

规范公司产品开发项目的文档体系，加强文档的标准化管理。

1.2适用范围

公司内所有产品开发项目。

2产品开发文档体系

在产品开发项目开发过程中，各阶段都有相应的文档输出，文档的编写应先于或同步于

开发工作。

产品开发项目过程中的文档体系如表1所示。

产品开发项目文档体系

序号文档名称文档作者备注

立项

1可行性研究报告项目经理

2产品规格书项目经理

3立项报告项目经理

需求

4系统需求规格说明书需求分析师

5软件需求规格说明书软件工程师

32系统测试用例测试工程师

33产品缺陷列表测试工程师

34认证性测试报告测试工程师研发中心出具

35系统测试报告测试工程师

发布

36验证测试报告认证代表

37回归测试报告测试工程师

38缺陷报告测试工程师

39用户使用文档技术资料工程师

交付结项

40项目总结报告项目经理

41项目结项表单项目经理

42系统测试报告测试工程师

43产品缺陷列表测试工程师

3文档质量的度量准则

评审文档质量的度量准则有以下六条：

完整性：所承担产品开发任务的项目组，需按照公司文档体系的规定编写相应的文档，

以保证在项目结束时其文档是齐全的。

正确性：在项目各个阶段所编写的文档的内容，必须真实的反映阶段的工作且与该阶段

的需求相一致。文档与所述的对象保持一致，必要时应进行实时的文档版本升级。

可读性：文档应该表达清晰、逻辑条理分明、表现形式通用。

简明性：在项目各个阶段所编写的各种文档的语言表达应该准确简练。

规范性：文档的规范性是指采用当前最新的模板。其完整性及内容的充实程度应不低于

模板的要求。

可追溯性：在项目各个阶段所编写的各种文档应该具有良好的可追溯性。由于各开发阶

段编制的文档与各阶段完成的工作有着密切的关系，前后阶段生成的文件，随着开发工作的

逐步扩展，具有一定的继承关系。在一个项目各开发阶段之间提供的文件必定存在着可追溯

的关系。

4主要角色和职责

4.1文档作者

文档作者包括公司内的项目组成员以及外协人员。文档作者在文档方面的主要工作为：

1）在项目开发过程的各个阶段中，按照规定及时地完成项目文档的编写工作，文档

作者有责任保证文档编写与开发同步。

2）文档作者不仅要审核文档字面上有无错漏，还要审核所陈述的技术内容是否精确，

及表达方式上是否清晰易懂。文档作者对文档的正确性、可读性和规范性全面负责。

3）文档作者保证所编写的文档与所描述的对象保持很好的一致性，必要时及时更新

文档，便于以后维护工作和后续开发工作的开展。

4.2项目经理

项目经理是控制文档准确性的关键环节，项目经理与文档作者一起构成文档正确性的直

接责任人。

项目经理在文档方面的主要工作为：

1）项目经理制定整个项目的文档计划（包含在项目计划中），并督促落实文档计划

的实施。

2）负责对技术内容正确性的检杳并校对文档内容与所述对象最新版本是否保持一

致。

3）定义项目文档的密级。

4.3PPQA

PPQA的主要工作为：

1）对文档作者提供的文档进行编号。

2）检查项目各阶段文档计划的执行情况确保文档的三级审核制度得到执行直至最

后归档。

3）对文档进行规范性审查。

4）根据文档计划，组织评审组对文档进行评审。

5）确认项目经理定义的文档密级，并确保文档的保密性得到有效控制。

4.4配置管理工程师

将评审通过或是部门经理审核通过的文档纳入基线管理，根据密级确认相应的权限。

4.5评审组

对需要评审的文档（可行性研究报告、项目计划书、需求规格说明书、概要设计书等）

的内容进行质量把关。

4.6部门经理

文档作者所属部门的部门经理对不需评审的文档进行最终审核。

5文档审核流程

对每一份文档要求在纳入基线前,从项目经理、PPQA、部门经理或评审组，进行三级

审核，这样，分别从文档质量的完备性、正确性、可读性、简明性、规范性、可追溯性等方

面进行分层把关，并最后签字确认其文档质量合格。

产品开发项目的文档管理层次结构如图1所示：

图1文档管理层次结构

5.1审核流程

产品开发项目文档在归档前均要经过多级审核，各审核一般都对应到文档封面的签名。

文档的审核归档流程如图2所示。

图2文档的审核流程

5.2归档签名

开发阶段文档在纳入基线之前需要经过三级审批，包括文档作者在内共四级签名：

>文档作者为文档的主要思想提供者和写作者。如果有多人参与则记录主要人员。

>项目经理：为在立项评审时指定的项目负责人。

>审核：PPQA。

>批准：如果此文档需评审，则批准人为评审组长；否则为文档作者所属部门的部门

经理。

5.3纳入基线

产品开发项目文档在经过三级审批通过后，由配置管理工程师纳入基线进行管理。

6文档保密制度

为确保产品开发项目文档的安全性，防止技术资料的外泄以及维护公司的权益，对每种

文档还应划定它们各自的保密级别。

每份文档的密级原则上根据其所含技术的保密要求以及产品进入市场的程度，由项目经

理负责指定。文档是按照与开发同步的原则写作，所以大多数文档在第一次纳入基线时，其

密级一般为"机密"，然后随着产品的逐渐成熟，其保密程度会逐渐放开，所以每份文档的

密级标志是动态的。纳入基线后的文档密级若需要改变，可由项目经理提出申请，配置管理

工程师责对文档所在配置库重新分配权限。

文档密级共分为四级：

>绝密指只有极少数人可以直阅的文档。如：核心技术的文档、预研项目的文档等。

此类文档应严格，呆需，配智库权限一船只分配给研发领导指定人员，须签订保密协

议。

>机密：指只有项目组的人可以查阅的文档。如：《软件概要设计说明书》、《硬件概

要设计说明书》等。对此类文档，配置库权限分配给项目组成员，其他人如需申请

权限，需经项目经理批准。

>普通：指在公司范围内开放的文档。如：《产品规格》等。此类文档可在公亘范围

内进行传阅。

>公开：指对外开放的文档。如：《产品说明书》及相关宣传资料等。对此类文档不

做权限控制。

以上密级归类仅供参考，各项目经理应根据产品竞争策略需要等实际情况确定归入

哪个密级，做到在保密基础上的资源共享。

7文档编号

文档以产品和项目为单位进行划分，对每篇文档根据其所属产品、项目和具体描述内容

定义一个唯一的编号。文档编号由PPQA分配。

注：硬件原理图、PCB图、结构图纸、BOM等文件编码不在此编号范围内。

7.1文档编号规则

文档编号由五部分组成，各部分由分隔，其构成如下：

产品型号一项目编号一阶段代号一模块代号

对文档进行编号时，各组成部分最好都有对应的代号及含义。如果不需区分模块，则以

代替模块代号。

其中：

>产品型号：一般对应于产品型号（外部型号x

>项目编号：所开发产品的项目编号。

>阶段代号：此文档对应的项目阶段代号，请参见7.2。

>模块代号：软件功能模块或硬件单板的缩写。

如：项目设计阶段的设计文档《MPE模块概要设计书》的文档标号为：CDVB5U0G_

DC-P071114-21_PD.SW_MPEo

7.2阶段代号

阶段代号由2~4位英文字母和T立”字符表示，构成如下：

主阶段代号.子阶段代号

1~2位1~2位

例如「可行性研究报告”文档对应的阶段编号为LR,"系统测试计划”文档对应的阶

段代号为SA.TP。

文档各阶段代号如表2所示。

文档阶段代号

项目阶段文档名称主阶段代号子阶段代号

可行性研究报告I(Initialization)F(Feasibility)

立项产品规格说明书I(Initialization)S(Specification)

立项报告I(Initialization)R(Report)

系统需求规格说明书R(Requirement)S(System)

软件需求规格说明书R(Requirement)SW(Software)

需求硬件需求规格说明书R(Requirement)HW(Hardware)

结构表R(Requirement)ST(Structure)

电源需求规格说明书R(Requirement)P(Power)

需求管理矩阵R(Requirement)M(Management)

系统总体设计说明书P(Planning)SL(Solution)

计划项目书P(Planning)I(Integration)

质量保证计划P(Planning)QA(QualityAssurance)

P(Planning)CM(Configuration

配置管理计划

Management)

进度计划P(Planning)S(Schedule)

软件概要设计说明书PD(PreliminarySW(Software)

Design)

硬件概要设计说明书PD(PreliminaryHW(Hardware)

设计

Design)

结构概要设计说明书PD(PreliminaryST(Structure)

Design)

软件详细设计说明书IM(Implementation)SW(Software)

单元测试计划书IM(Implementation)UP(UnitTestingPlan)

单元测试用例IM(Implementation)UC(UnitTestingCase)

单元测试报告IM(Implementation)UR(UnitTestingReport)

实现

产品集成计划IM(Implementation)IP(IntegrationPlan；

集成测试计划书IM(Implementation)TP(TestingPlan)

接口说明书IM(Implementation)I(Interface)

集成测试用例IM(Implementation)TC(TestingCase)

集成测试报告IM(Implementation)TR(Testing