文件编写规范(完整资料).doc

【最新整理，下载后即可编辑】

密级：内部公开

文档编号：

版本号：V1.0

分册名称：第1册/共1册

文件编写规范

xxx科技有限公司

文件更改摘要

目录

1.目的和范围 (4)

2.目标 (4)

3.术语表 (4)

4.文档编号规则 (5)

5.文档命名规范 (5)

6.文件结构规定 (6)

7.封面 (7)

8.修订页 (8)

9.正文内容格式 (8)

10.文件版本号和文件命名规定 (9)

10.1.文件版本号规定 (9)

10.2.文件命名规定 (9)

1.目的和范围

●背景说明：本文件作为公司内部文档管理文件，所有公司

内编写的文档，均应遵守本规定，作为公司的所有文档编

写统一要求。

●范围：所有的CMMI执行过程中产生的文档，均应当执行

本文件要求作为基础的要求，如果该部分的体系文件存在

明确的要求的，按照体系文件要求执行，没有的则按照本

文件执行。

2.目标

规范和统一公司管理体系中所有相关文件的风格和样式，指导公司程序文件、模版文件以及各种记录文件的编写。

3.术语表

●文件标识：文件的属性标志，包括文件名称、文件编号、

版本、生效日期、审批状态、密级等。

●程序文件：描述为完成管理体系中所有主要活动提供方法

和指导，分配具体的职责和任务而定义的文件。

●模版文件：为了使管理体系有效运行，组织统一设计的一

些实用的表格和给出活动结果的报告，规范记录组织的管理体系运行情况。

●记录文件：简称记录，是组织根据设计的模版和体系要求，

填写的表格或者给出活动结果的报告，作为管理体系运行的证据。

●修订页：记录文件的修订历史，所有程序文件、除了表格

以外的模版和记录都需要有变更履历，一般位于程序文件的第二页。

●文档密级：指本文档的保密程度，共分绝密、机密、秘密、

内部公开、公开五级制度。

●绝密：涉及公司与客户或上游供应商，下游分销商所

签订相关的文档资料。仅限于公司最高管理层及各资

料所涉及的经过相应管理人员授权的相关人员查阅。

●机密：公司内部所相关的规章制度及技术规范，开发

手册等；还有各项目开发文档、管理文档及软件产品

等仅供相关部门高级领导以及经过授权后相关人员查

阅。

●秘密：需交付用户或与客户进行交流的文档与产品，

可供相关项目客户查阅。

●内部公开：内部不限制，公司内部任何可以任何形式

获得文档的信息并阅读、保存、修改后自用等等，但

是不允许向外传播的文件。

●公开：项目组开发过程中的自用文档或面向售前工作

的部分项目介绍材料等。

●版本标识：作为文档的版本区分。所有发布版本之前不得

大于1.0，发布版本作为1.0，而其后只有重大修改可以调整小数点前的版本号，局部修改调整小数点后版本号，并在修定记录表中保留记录。

4.文档编号规则

过程域与英文标识对应表：（SSP：标准过程集）

5.文档命名规范

公司所有项目及项目内所有技术文档应按照以下规范进行统一命名。

一、项目及项目编号的命名规范为（合同开发类项目、合同维护类项目）：

二、项目文档的命名规范为：

6.文件结构规定

所有记录中除表格之外的文件，在编制过程中应按照相关编制规范编写。文件通常包括：封面、修订页、目录、页眉、页脚和正文。

●页码：页码由第1章首页开始，显示在页脚，页脚左侧为

公司全称,右侧为页码.格式第X 页共Y页(其中X,Y均

为阿拉伯)；

●页眉：页眉内容为本文档的文件名称+版本号；右侧对齐。

●页面设置：除个别特殊需要以外，纸型设为纵向A4，页边

距采用默认值（上下均为2.54cm，左右均为3.17cm）。

7.封面

8.修订页

修订页内容建议包括：版本号、修改日期、作者（修改人）、修订要点等，如下表所示，可以根据实际情况添加内容。注意，在由模板文件生成实际组织或项目文件后，修订页中的原修订记录必须清除，改为实际文件的修订记录。修订页中的版本和作者

要与封面的版本和编制一致。

9.正文内容格式

程序文件正文部分一般建议包含以下内容：

1.目的/方针：

●目的：程序所控制的活动及控制目的；

2.范围:程序所涉及的有关部门、活动、相关人员和产品。

3.术语表（可选）：程序文件中的专用术语、缩略语等。

4.角色和职责：规定负责实施该项程序的部门或人员及其责

任和权限。

5.入口准则：启动该程序需要满足的条件

6.输入：作为该程序输入的工作产品

7.流程图

8.主要活动

作活动的逻辑顺序写出开展该项活动的各个环节。一般应说明以下内容：

●规定应做的事情（What）；

●明确活动的实施者（Who）；

●规定活动的时间（When）；

●说明在何处实施（Where）；

●规定具体实施办法（How）；

●所采用的材料、设备、引用的文件等；

●如何进行控制，应保留的记录；

例外特殊情况的处理方式等。

9.输出：作为该程序输出的工作产品

10.出口准则：结束该程序需要满足的条件

11.引用文档：涉及到的相关程序文件、模版文件以及其他技

术或管理文件。

12.使用模板