文件编写规范

密密 级：内部公开级：内部公开 文档编号：文档编号： 版版 本本 号：号：V1.0V1.0 分册名称：第分册名称：第 1 1 册册/ /共共 1 1 册册 文件编写规范文件编写规范 xxx 科技有限公司科技有限公司 编制：生效日期： 审核：批 准： 文件更改摘要文件更改摘要 日期日期版本号版本号修订说明修订说明修订人修订人审核人审核人批准人批准人 目目 录录 1.1.目的和范围目的和范围.4 2.2.目标目标.4 3.3.术语表术语表.4 4.文档编号规则文档编号规则.5 5.文档命名规范文档命名规范.5 6.文件结构规定文件结构规定.6 7.封面封面.7 8.修订页修订页.8 9.正文内容格式正文内容格式.8 10.文件版本号和文件命名规定文件版本号和文件命名规定.9 10.1.10.1.文件版本号规定文件版本号规定.9 10.2.10.2.文件命名规定文件命名规定.9 1.1. 目的和范围目的和范围 背景说明：背景说明：本文件作为公司内部文档管理文件，所有公司内编写的文档，均应遵 守本规定，作为公司的所有文档编写统一要求。 范围：范围：所有的 CMMI 执行过程中产生的文档，均应当执行本文件要求作为基础的要 求，如果该部分的体系文件存在明确的要求的，按照体系文件要求执行，没有的 则按照本文件执行。 2.2. 目标目标 规范和统一公司管理体系中所有相关文件的风格和样式，指导公司程序文件、模版文 件以及各种记录文件的编写。 3.3. 术语表术语表 文文件件标标识识： 文件的属性标志，包括文件名称、文件编号、版本、生效日期、审 批状态、密级等。 程序文件：程序文件：描述为完成管理体系中所有主要活动提供方法和指导，分配具体的职责 和任务而定义的文件。 模版文件：模版文件：为了使管理体系有效运行，组织统一设计的一些实用的表格和给出活动 结果的报告，规范记录组织的管理体系运行情况。 记录文件：记录文件：简称记录，是组织根据设计的模版和体系要求，填写的表格或者给出活 动结果的报告，作为管理体系运行的证据。 修订页：修订页：记录文件的修订历史，所有程序文件、除了表格以外的模版和记录都需要 有变更履历，一般位于程序文件的第二页。 文档密级文档密级：指本文档的保密程度，共分绝密、机密、秘密、内部公开、公开五级 制度。 绝密绝密：涉及公司与客户或上游供应商，下游分销商所签订相关的文档资料。 仅限于公司最高管理层及各资料所涉及的经过相应管理人员授权的相关人员 查阅。 机密机密：公司内部所相关的规章制度及技术规范，开发手册等；还有各项目开 发文档、管理文档及软件产品等仅供相关部门高级领导以及经过授权后相关 人员查阅。 秘密秘密：需交付用户或与客户进行交流的文档与产品，可供相关项目客户查阅。 内部公开内部公开： 内部不限制，公司内部任何可以任何形式获得文档的信息并阅读、 保存、修改后自用等等，但是不允许向外传播的文件。 公开公开：项目组开发过程中的自用文档或面向售前工作的部分项目介绍材料等。 版本标识版本标识：作为文档的版本区分。所有发布版本之前不得大于 1.0，发布版本作为 1.0，而其后只有重大修改可以调整小数点前的版本号，局部修改调整小数点后版 本号，并在修定记录表中保留记录。 4.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-过程域标识-文档类型标识-文档英文简称 说明说明XXXX 为 xxx 科技有限公司英文缩写。 文档简称：为英文缩写。 文档英文简称不可重复。 举例举例组织过程定义过程, 属于组织过程定义的过程文件，过程域标识为 OPD，文档类型标识为 Proc，简称 OPDP，则该过程文档编号为： XXXX OPD-Proc-OPDP,如有多个在后面加-1、-2 区别 5.5. 文档命名规文档命名规范范 公司所有项目及项目内所有技术文档应按照以下规范进行统一命名。 一、项目及项目编号的命名规范为（合同开发类项目、合同维护类项目）： 项目命名规则项目产品 举例城市应急救援指挥系统 项目编号规则客户英文简称(或汉语拼音简称)-产品英文简称 举例 RFPreview 说明客户英文简称(或汉语拼音简称)及产品英文简称应避免重名 二、项目文档的命名规范为： 项目命名-过程模板文档名文档命名规则 对可能重名的文档如项目周报，命名如下：项目编号-过程模 板文档名-（文档编者） 注：（文档编者）在不导致文档名称重复的情况下可以省略。 举例RFPreview-立项申请表 项目编号-过程域-英文编号文档编号规则 对可能重复的文档编号，命名如下：项目编号-过程域-英文编 号，如有多个在后面加-1、-2 区别 举例 RFPreview-PIM-IAPR 说明项目编号及标准文档模板编号应避免重名 6.6. 文件结构规定文件结构规定 所有记录中除表格之外的文件，在编制过程中应按照相关编制规范编写。文件通常包 括：封面、修订页、目录、页眉、页脚和正文。 页码：页码：页码由第 1 章首页开始，显示在页脚，页脚左侧为公司全称,右侧为页码. 格式第 X 页 共 Y 页(其中 X,Y 均为阿拉伯)； 页眉：页眉：页眉内容为本文档的文件名称+版本号；右侧对齐。 页面设置：页面设置：除个别特殊需要以外，纸型设为纵向 A4，页边距采用默认值（上下 均为 2.54cm，左右均为 3.17cm）。 7.7. 封面封面 密密 级：级： 文档编号：文档编号： 版版 本本 号：号：V1.0V1.0 分册名称：第分册名称：第 1 1 册册/ /共共 1 1 册册 文件名称文件名称 xxx 科技有限公司科技有限公司 编制： 生效日期： 审核： 批准： 8.8. 修订页修订页 修订页内容建议包括：版本号、修改日期、作者（修改人） 、修订要点等，如下表所示， 可以根据实际情况添加内容。注意，在由模板文件生成实际组织或项目文件后，修订页中 的原修订记录必须清除，改为实际文件的修订记录。修订页中的版本和作者要与封面的版 本和编制一致。 日期日期版本号版本号修订说明修订说明修订修订 人人 审核审核 人人 批准批准 人人 9.9. 正文内容格式正文内容格式 程序文件正文部分一般建议包含以下内容： 1.1. 目的目的/ /方针：方针： 目的：程序所控制的活动及控制目的； 2.2. 范围范围: :程序所涉及的有关部门、活动、相关人员和产品。 3.3. 术语表（可选）：术语表（可选）：程序文件中的专用术语、缩略语等。 4.4. 角色和职责：角色和职责：规定负责实施该项程序的部门或人员及其责任和权限。 5.5. 入口准则：入口准则：启动该程序需要满足的条件 6.6.输入：输入：作为该程序输入的工作产品 7.7. 流程图流程图 8.8. 主要活动主要活动 作活动的逻辑顺序写出开展该项活动的各个环节。一般应说明以下内容： 规定应做的事情（What）； 明确活动的实施者（Who）； 规定活动的时间（When）； 说明在何处实施（Where）； 规定具体实施办法（How）； 所采用的材料、设备、引用的文件等； 如何进行控制，应保留的记录； 例外特殊情况的处理方式等。 9.9.输出：输出：作为该程序输出的工作产品 10.10. 出口准则：出口准则：结束该程序需要满足的条件 11.11. 引用文档：引用文档：涉及到的相关程序文件、模版文件以及其他技术或管理文件。 12.12. 使用模板使用模板 10.10.文件版本号和文件命名规定文件版本号和文件命名规定 10.1.10.1. 文件版本号规定文件版本号规定 文件的版本号以“A.B”格式标识，A 和 B