文件编写规范.doc

文件编写规范V1.0
密 级：内部公开
文档编号：
版 本 号：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. 目的和范围
l 背景说明：本文件作为公司内部文档管理文件，所有公司内编写的文档，均应遵守本规定，作为公司的所有文档编写统一要求。
l 范围：所有的CMMI执行过程中产生的文档，均应当执行本文件要求作为基础的要求，如果该部分的体系文件存在明确的要求的，按照体系文件要求执行，没有的则按照本文件执行。

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

3. 术语表
l 文件标识：文件的属性标志，包括文件名称、文件编号、版本、生效日期、审批状态、密级等。
l 程序文件：描述为完成管理体系中所有主要活动提供方法和指导，分配具体的职责和任务而定义的文件。
l 模版文件：为了使管理体系有效运行，组织统一设计的一些实用的表格和给出活动结果的报告，规范记录组织的管理体系运行情况。
l 记录文件：简称记录，是组织根据设计的模版和体系要求，填写的表格或者给出活动结果的报告，作为管理体系运行的证据。
l 修订页：记录文件的修订历史，所有程序文件、除了表格以外的模版和记录都需要有变更履历，一般位于程序文件的第二页。
l 文档密级：指本文档的保密程度，共分绝密、机密、秘密、内部公开、公开五级制度。
l 绝密：涉及公司与客户或上游供应商，下游分销商所签订相关的文档资料。仅限于公司最高管理层及各资料所涉及的经过相应管理人员授权的相关人员查阅。
l 机密：公司内部所相关的规章制度及技术规范，开发手册等；还有各项目开发文档、管理文档及软件产品等仅供相关部门高级领导以及经过授权后相关人员查阅。
l 秘密：需交付用户或与客户进行交流的文档与产品，可供相关项目客户查阅。
l 内部公开： 内部不限制，公司内部任何可以任何形式获得文档的信息并阅读、保存、修改后自用等等，但是不允许向外传播的文件。
l 公开：项目组开发过程中的自用文档或面向售前工作的部分项目介绍材料等。
l 版本标识：作为文档的版本区分。所有发布版本之前不得大于1.0，发布版本作为1.0，而其后只有重大修改可以调整小数点前的版本号，局部修改调整小数点后版本号，并在修定记录表中保留记录。
4. 文档编号规则
过程域与英文标识对应表：（SSP：标准过程集）
SSP过程类别
SSP定义的过程域
英文标识
过程管理
组织过程聚焦
OPF
组织过程定义
OPD
组织培训
OT
项目管理
立项
PIM
集成项目管理
IPM
项目策划
PP
项目监督和控制
PMC
风险管理
RSKM
结项
PCM
采购
SAM
项目研发
需求开发与管理
RD
系统设计编码
SD
产品集成
PI
测试
TS
评审
TR
产品发布
PRDI
产品实施
PA
项目实施与维护
PAM
过程支持
配置管理
CM
过程和产品质量保证
PPQA
测量与分析
MA
决策分析和决定
DAR
文档类型与英文标识对应表：
序号
文档类型
文档标识
1
过程
Proc
2
规程、规范、指南
Regu
3
模版、记录表格、工具
Temp
文档编号编写规则：
规则
XXXX-过程域标识-文档类型标识-文档英文简称
说明
l XXXX为xxx科技有限公司英文缩写。
l 文档简称：为英文缩写。
l 文档英文简称不可重复。
举例
组织过程定义过程, 属于组织过程定义的过程文件，过程域标识为OPD，文档类型标识为Proc，简称OPDP，则该过程文档编号为：XXXX –OPD-Proc-OPDP,如有多个在后面加-1、-2区别

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

一、项目及项目编号的命名规范为（合同开发类项目、合同维护类项目）：
项目命名规则
项目产品
举例
城市应急救援指挥系统
项目编号规则
客户英文简称(或汉语拼音简称)-产品英文简称
举例
RFPreview
说明
客户英文简称(或汉语拼音简称)及产品英文简称应避免重名

二、项目文档的命名规范为：
文档命名规则
项目命名-过程模板文档名
对可能重名的文档如项目周报，命名如下：项目编号-过程模板文档名-（文档编者）
注：（文档编者）在不导致文档名称重复的情况下可以省略。
举例
RFPreview-立项申请表
文档编号规则
项目编号-过程域-英文编号
对可能重复的文档编号，命名如下：项目编号-过程域-英文编号，如有多个在后面加-1、-2区别
举例
RFPreview-PIM-IAPR
说明
项目编号及标准文档模板编号应避免重名

6. 文件结构规定
所有记录中除表格之外的文件，在编制过程中应按照相关编制规范编写。文件通常包括：封面、修订页、目录、页眉、页脚和正文。
l 页码：页码由第1章首页开始，显示在页脚，页脚左侧为公司全称,右侧为页码.格式第 X 页 共 Y页(其中X,Y均为阿拉伯)；
l 页眉：页眉内容为本文档的文件名称+版本号；右侧对齐。
l 页面设置：除个别特殊需要以外，纸型设为纵向A4，页边距采用默认值（上下均为2.54cm，左右均为3.17cm）。
7. 封面
密 级：
文档编号：
版 本 号：V1.0
分册名称：第1册/共1册

文件名称

xxx科技有限公司

编制：
生效日期：
审核：
批准：

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

9. 正文内容格式
程序文件正文部分一般建议包含以下内容：
1. 目的/方针：
l 目的：程序所控制的活动及控制目的；
2. 范围:程序所涉及的有关部门、活动、相关人员和产品。
3. 术语表（可选）：程序文件中的专用术语、缩略语等。
4. 角色和职责：规定负责实施该项程序的部门或人员及其责任和权限。
5. 入口准则：启动该程序需要满足的条件
6. 输入：作为该程序输入的工作产品
7. 流程图
8. 主要活动
作活动的逻辑顺序写出开展该项活动的各个环节。一般应说明以下内容：
l 规定应做的事情（What）；
l 明确活动的实施者（Who）；
l 规定活动的时间（When）；
l 说明在何处实施（Where）；
l 规定具体实施办法（How）；
l 所采用的材料、设备、引用的文件等；
l 如何进行控制，应保留的记录；
l 例外特殊情况的处理方式等。
9. 输出：作为该程序输出的工作产品
10. 出口准则：结束该程序需要满足的条件
11. 引用文档：涉及到的相关程序文件、模版文件以及其他技术或管理文件。
12. 使用模板

10. 文件版本号和文件命名规定
10.1. 文件版本号规定
文件的版本号以“A.B”格式标识，A和B均为数字，其中‘A’注释为结构级修改；‘B’ 注释为小范围修改。
10.2. 文件命名规定
l 程序文件、模版文件的命名与该文档的标题相同；
l 项目记录文件的命名为“项目代码＋标题”；
l 其他记录文件的命名为“产生日期＋标题”，对于个人年度工作总结的文件命名为“XXXX年度个人工作总结-人员姓名”。
l 文件名中，产生日期和其他部分用半角横线“-”连接。