文档编写规范

文件编写规范XXXXXX有限公司文件编号GF_OPF_REGU_FNS当前版本V1.0机密等级20XX编制者审核者批准者批准日期20XX-5-15XXXXXX有限公司对本文件资料享受著作权及其它专属权利，未经书面许可,不得将该等文件资料（其全部或任何部分）披露予任何第三方，或进行修改后使用。XXXXXXXX公司#文件更改摘要：日期版本号修订说明修订人审核人批准人20XX-5-15V1.0正式发布目录TOC\o"1-5"\h\z丄目的和范围32.目标3玄术语表3文档编号规则4文档命名规范5项目命名552.项目文档命名5文件结构规定6Word文件6Excel文件7封面8&文件更改摘要8版本标识9管理文件版本标识：9酉己置项版本标识：9基线版本标识：10模板应用要求10OSP文档编号11引用文档111.目的和范围•背景说明：本文件作为XXXXXX有限公司内部文档管理文件，所有公司内编写的文档，均应遵守本规定，作为公司的所有文档编写统一要求。•范围：所有的CMMI执行过程中产生的文档，均应当执行本文件要求，如果该部分的体系文件存在明确的要求的，按照体系文件要求执行，没有的则按照本文件执行。目标规范和统一公司管理体系中所有相关文件的风格和样式，指导公司程序文件、模板文件以及各种记录文件的编写。术语表◊文件标识：文件的属性标志，包括文件名称、文件编号、版本、生效日期、审批状态、密级等。过程、规程文件：描述为完成管理体系中所有主要活动提供方法和指导，分配具体的职责和任务而定义的文件。模板文件：为了使管理体系有效运行，组织统一设计的一些实用的表格和给出活动结果的报告，规范记录组织的管理体系运行情况。记录文件：简称记录，是组织根据设计的模板和体系要求，填写的表格或者给出活动结果的报告，作为管理体系运行的证据。◊文档密级：指本文档的保密程度，共分绝密、机密、秘密、20XX、公开五级制度。绝密：涉及公司与客户或供应商所签订相关的文档资料。仅限于公司最高管理层及相应管理人员查阅。机密：公司内部的规章制度及技术规范，开发手册等；还有各项目开发文档、管理文档及软件产品等。仅供相关部门高级领导以及经过授权人员查阅。秘密：需交付用户或与客户进行交流的文档与产品，可供相关项目客户查阅。20XX：内部不限制，公司内部任何人可以任何形式获得文档的信息并阅读、保存、修改后自用等等，但是不允许向外传播的文件。公开：项目组开发过程中的自用文档或面向售前工作的部分项目介绍材料等。修订页：记录文件的修订历史，所有程序文件、除了表格以外的模板和记录都需要

有变更履历，一般位于程序文件的第二页。版本标识：作为文档的版本区分。所有发布版本之前不得大于1.0，发布版本作为1.0，而其后只有重大修改可以调整小数点前的版本号，局部修改调整小数点后版本号，并在修订记录表中保留记录。文档编号规则过程域与英文标识对应表：过程类别OSP定义的过程域英文标识过程管理组织过程聚焦OPF组织过程定义OPD组织培训OT项目管理立项PIM集成项目管理IPM项目策划PP项目监督和控制PMC风险管理RSKM结项PCM项目研发需求开发与管理RDM系统设计编码TS产品集成PI测试TST评审Review项目实施与验收VAL过程支持配置管理CM过程和产品质量保证PPQA度量与分析MA决策分析和决定DAR文档类型与英文标识对应表：序号文档类型文档标识

1过程PROC2规程、规范、指南REGU3模板、记录表格、工具TEMP文档编号编写规则：规则公司名缩写过程域标识文档类型标识文件名称英文缩写或者拼音首字说明公司名称缩写为GF举例风险数据表（RSKD）,属于项目管理过程域的模板，过程域标识为RSKM，文档类型标识为TEMP，文件名称英文缩写为RSKD，则该文档编号为：GF_RSKM_TEMP_RSKD文档命名规范公司所有项目及项目内所有技术文档应按照以下规范进行统一命名5.1.项目命名项目命名规则客户简称-项目产品举例项目编号规则客户英文简称（或汉语拼音简称）-产品英文简称举例GDYD-PORTAL说明客户英文简称（或汉语拼音简称）及产品英文简称应避免重名5.2.项目文档命名项目文档命名规则项目编号—文件名称举例项目编号为GDYD-PORTAL,项目文件名为风险数据表，则改文档名为：GDYD-PORTAL_风险数据表说明如果遇到重名情况，可在表后面直接添加相关能够区分的标志（姓名，日期等）。如：GDYD-PORTAL_个人工作周报20XXW20项目文档中的文项目名称件编号命名规则举例项目名称：那么项目文件中的文件编号为：文件结构规定所有记录中除表格之外的文件，在编制过程中应按照相关编制规范编写。Word文件Word文件包括：封面、修订页、目录、页眉、页脚和正文。•页码：封面为页码第一页，页码由封面后第一页开始显示，显示在页脚，格式为第X页共Y页（其中X,Y均为阿拉伯数字）；•页眉：页眉内容左侧为公司logo，右侧为本文档的文件名称，设置首页不同；页脚：页脚内容左侧为公司名中文全称，右侧为页码，设置首页不同；•页面设置：除个别特殊需要以外，纸型设为纵向A4,页边距采用默认值（上下均为2.54cm，左右均为3.17cm）；密级：文档封面的右上角标识宋体五号加粗字体的密级，带黑色细线文本框；文件属性：填写文件属性中的作者、文件名称、公司名称；文件更改摘要：宋体5号字，版本号标识为0.1；正文：文件正文宋体5号字，每段开始缩进两个汉字，使用1.5倍行距；一级标题：使用样式库中的标题一（宋体四号字加粗黑色）二级标题：使用样式库中的标题二（宋体小四号字加粗黑色）三级标题：使用样式库中的标题三（宋体小四号字加粗黑色）四级标题：使用样式库中的标题四（宋体五号字加粗黑色）；目录：宋体五号字不加粗不使用斜体，段落间距：段前段后均设为0，行距设置为单倍行距；表格标题：表格标题宋体五号字加粗中对齐；引用文件：所有文中出现的文件名称均有书名号；填写说明：模板文件在需要填写的内容给出填写说明。Excel文件Excel文件包括：封面、修订页、正文。密级：文档封面的右上角标识宋体10号加粗字体的密级，带黑色细线文本框；•表单：所有sheet的名称都正确命名，空白表单删除；•页眉页脚：清除页眉页脚的内容；文件属性：填写作者、文件名称、公司名称；文件更改摘要：宋体10号字，版本号标识为V0.1；正文表格：使用宋体10号字；正文表格标题：使用加粗宋体12号字；如需打印的文件，使用加粗宋体18号字表格边框：使用细实线；选择项：模板文件对于固定选项的字段使用下拉列表提供选择；自动汇总：模板文件对于统计结果字段设置成为自动汇总；•填写说明：模板文件在重要的需要填写的内容给出填写说明。封面XXX过程XXX公司文件编号当前版本机密等级编制者审核者批准者批准日期XXXXXX有限公司对本文件资料享受著作权及其它专属权利，未经书面许

可，不得将该等文件资料（其全部或任何部分）披露予任何第三方，或进行修改

后使用。文件更改摘要文件更改摘要内容建议包括：版本号、修改日期、作者（修改人）、修订说明等，如下表所示，可以根据实际情况添加内容。注意，在由模板文件生成实际组织或项目文件后，文件更改摘要页中的原修订记录必须清除，改为实际文件的修订记录。文件更改摘要中的版本和作者要与封面的版本和编制一致。正式发布前（版本1.0）之前无需填写批准人。修订页9.版本标识根据产品的需要，软件产品制造过程中的每个配置项和不同阶段的基线发布都需要进行相应的版本标识，下面分别作以介绍。9.1.管理文件版本标识：版本的基准格式为：x.y新起草的文件版本定为0.1版。逐步完善的文件但还没有通过评审的，版本每次升级加0.1，但必须小于1.0版。通过正式评审的文件版本升级为1.0版，可对外发布。成为基准的文件如有少量修改，可视情况升级为l.y版，“y”可根据次数依次递增，取值范围为“1~9”。如有实质性的改变时，文件的版本升级为2.0版，依此类推，“y”可依次递增，取值范围为“1~9”。管理文件发布标识图：配置项版本标识：未成为基准的配置项的版本的取值范围为：“0.01~0.99版”成为基准的配置项的版本为Ver1.00版。如果今后有修正，从Ver1.01逐渐递增。对于从其他产品继承来的配置项，在原来配置项版本的基础上作适当的对应。例如：如果以前的配置项为Verl.00，在本次项目中基本没有修改的，维持原来的配置号；如果有大的增加，此配置项以1为本项目的增加幅度，在本项目中最终增为Ver2.00,以后以此类推。配置项标识图：基线版本标识：配置管理员负责把基线发布给外部客户(如发布运行基线)或内部使用(如为测试而发布)。最初基线版本创建：基线的类型见《配置管理过程》，最初的基线版本为1.00。基线变更时的版本：◊当基线发生变更时，我们可定义它的版本逐渐递增。◊当内容部份有少量变化，不影响其功能时，版本可在x.00<x.yy<x.99间变化。◊当发生功能性的变化时，如新增功能、功能完全改变、模式