CMMI-文件编写规范

文件编写规范文件编号保密级别总页数编制

变更日志编号版本修改内容修改人修改日期10.10创建初稿20.20内部评审31.00发布目录1 编写目的 32 适用范围 23 文件编制规范 33.1 文件的结构 33.2 文件的版面 43.3 封面 43.3.1 技术说明书、用户手册、配置手册、标书封面 43.3.2 设计文档、考察研究报告、输入文件封面 43.4 变更日志 53.5 扉页 53.6 目录 63.7 正文 63.7.1 页眉和页脚 63.7.2 各级标题 63.7.3 正文内容 73.7.4 表格文件 73.7.5 图文件 83.8 封三 83.9 封底 84 打印 8A.1技术文件封面示例 9A.2变更日志示例 10A.3扉页示例 11A.4目录 12A.5封底示例 13文件编写规范PAGE13编写目的为使公司所用的各种文件编写规范、统一，进而提高工作效率特编写本文。适用范围本文适用于以下文档，超出本范围的文档，也可借鉴本文提供的格式和要求。组织体系文件设计文档技术说明书用户手册配置手册考察研究报告输入文件标书文件编制规范文件的结构其中《技术说明书》、《用户手册》、《配置手册》、《标书》四类文件结构为：封面、扉页、目录、正文、封三、封底；《设计文档》、《考察研究报告》、《输入文件》三类文件结构为封面、变更日志、目录、正文。建立文件时，需对文件的属性进行填写。文件的版面NTS8300、NTS8700、NTS-500、NTS-700、NTS-800、NTS-900产品《用户手册》、《配置手册》用纸规格均为A5，页边距设置分别为上1.5cm，下1.5cm，左2.0cm，右1.0cm；页眉到边缘距离：0.55cm；页脚到边缘距离：0.85cm；正文行距为：1.5倍行距。所有《技术说明书》、《设计文档》、《考察研究报告》、《输入文件》、《标书》用纸规格为A4，页边距设置分别为上2.0cm，下2.0cm，左2.5cm，右1.5cm；页眉到边缘距离：1.5cm，页脚到边缘距离：1.75cm；正文行距为：1.5倍行距。其他不在此范围内的资料可参考上述标准执行。封面技术说明书、用户手册、配置手册、标书封面封面为该类文件第一组成部分，封面包括文件名称、封面图片、公司名称三大组成部分。该封面风格按当前应用的规范应用，暂不作强制规定，但同类文件需保持统一样式。设计文档、考察研究报告、输入文件封面该类文件封面包括公司LOGO、文件名称、控制栏、公司名称及版权声明五个组成部分；公司LOGO设置：采用图片型式，如下图3-1所示，图片高度1.15cm，纵横比例锁定，四周型版式，居中，距页眉4个单倍小四行距；图3-1公司LOGO文件名称设置：距LOGO10个单倍小四行距，采用初号黑体加粗居中，名称较长时可分行显示，1行不超过10个汉字；控制栏设置：距文件名称12个单倍小四行距，字体为黑体小四号。控制栏为表格型式，表格行高统一为1cm，文字为黑体小四，文字居中。表格按窗口自动调整。其中修改状态的表示方法：修改状态表示为“版次号+修改标识”，修改标识用一位大写字母表示，取值从“A～Z”。文件每修改一次，对应一个修改状态，文件升级版本时，修改状态清空。控制栏具体内容如表3-1所示：文件编号XX-X-XXXXX-XX生效日期090312受控编号保密级别二级版本号V1.15修改状态F总页数7正文4附录无编制审核批准表3-1控制栏公司名称设置：采用图片型式，距控制栏约3个单倍小四行距，图片设置为嵌入型版式，居中，高0.61厘米，纵横比例锁定，如下图3-2所示；图3-2公司名称版权声明设置：位于公司名称下方，紧接公司名称，字体为黑体小三加粗，居中，外加括号；格式具体参见A.1技术文件封面示例。变更日志非一次性文件都要有有变更日志，如《设计文档》、《输入文件》等，具体格式参见A.2变更日志示例。其中“变更日志”字体为黑体三号加粗，段落为1.5倍行距，表格中的文字为宋体小四居中，表格设为按窗口自动调整。扉页《设计文档》、《考察研究报告》、《输入文件》、《标书》四类文件需有扉页，扉页是该类文件的第二组成部分，扉页包括公司LOGO、产品名称、文件名称、文件版本号、公司名称、编写日期六类组成部分；公司LOGO设置：采用图片型式，如图3-1所示，图片高度1.15cm，纵横比例锁定，嵌入型版式，居中，距页眉约4个单倍小四行距；产品名称设置：距LOGO约2个单倍小四行距。其中，《技术说明书》、《用户手册》、《配置手册》三类文件产品名称字体设为小一号黑体加粗居中，名称较长时可分行显示，1行不超过10个汉字；《标书》文件产品名称位置填写标书名称，字体设置为初号黑体加粗居中，名称较长时可分行显示，1行不超过10个汉字；文件名称设置：距产品名称4个单倍小四行距，纵向表示。其中，《技术说明书》、《用户手册》、《配置手册》三类文件产品名称字体设为小一号黑体加粗居中；《标书》文件此处显示为“投标文件”，字体设置为初号黑体加粗居中；文件版本号设置：距文件名称8个单倍小四行距，字体采用三号黑体居中；公司名称设置：采用图片型式位于日期正下方，图片设置为嵌入型版式，居中，高0.61厘米，纵横比例锁定，如图3-2所示；编写日期设置：位于公司名称下方，字体设置为三号黑体居中；《标书》文件扉页格式详见A.3扉页示例。目录目录撰写格式设置：“目录”两字（三号黑体），居中，下空2个单倍小四行距，目录显示三级大纲。文字为小四宋体，段落设置为段前0行，段后0.5行，单倍行距。章、节、小节分别以“1”、“1.1”、“1.1.1”等数字依次标出。目录设置格式为如下图：图3-3目录设置目录一般为文件编写结束后自动生成。目录部分不用页眉、页脚。格式参见A.4目录。正文正文部分包括页眉、页脚、各级标题、正文内容、表格和图。注意事项：同一级别和使用同样项目符号的文字要在同一纵轴线上；对于双面打印的文件，一章的开始一定要在奇数页上；当标题和相应内容不在同一页面时，调整标题到下一页面；调整图的位置大小，保证其在打印区内。页眉和页脚前言或引言需单独编注页码，不加页眉和页脚。页眉的左边为公司LOGO图片，图片高度为0.4cm，锁定纵横比，左对齐；页眉的右边为文件的名称，字体设为宋体五号加粗；页眉段前0行，段后0.5行，页眉下方有0.5磅横线。页脚为页码居中即可。各级标题标题第一级为“1”、“2”、“3”等，第二级为“1.1”、“1.2”、“1.3”等，第三级为“1.1.1”、“1.1.2”、“1.1.3”等，各级末尾不加标点。注意事项：每章标题字体设置为三号黑体加粗居中，设定大纲级别为1级，段前、段后均为6磅，1.5倍行距；各节（如“1.1”）字体设置为四号黑体加粗左起顶格，设定大纲级别为2级，段前4磅，段后3磅，1.5倍行距；各小节（如“1.1.1”）字体设置为小四号黑体加粗左起顶格打印，设定大纲级别为3级，段前、段后为0磅，1.5倍行距；换行后打印正文。正文中总项包括的分项采用（1）、（2）、（3）…的序号，缩进2.1cm；对分项中的小项采用①、②、③…的序号，缩进4cm；项目编号可以采用项目符号加以标注。可根据实际情况自选，一份文件建议只使用一种，统一规范。正文内容正文字体设置为五号宋体，首行缩进2个字符，段前0磅，段后0磅，1.5倍行距。表格文件文档中会插入各种表格，表格内的字体设置为宋体五号，表格的格式要求由相应的文件具体规定。表格按章顺序编号，如表5-4为第五章第张四表，编号后空一格显示表格名称，编号和名称的位置为该表格的正下方居中，字体为宋体5号。如下表3-2所示：图符说明方向键“上”，用于切换菜单及输入密码（文中用↑表示）方向键“下”，用于切换菜单及输入密码（文中用↓表示）方向键“左”，用于切换菜单及输入密码（文中用←表示）方向键“右”，用于切换菜单及输入密码（文中用→表示）修改键“加”，用于切换参数选项，或增大数字修改键“减”，用于切换参数选项，或减小数字用于确认用户所做的操作，或进入下级菜单，或自运行显示状态调出主菜单用于中止用户所做的操作，或退到上一级菜单，或从主菜单切换到运行显示状态复归处于保持状态的异常信号灯，或信号继电器，当异常信号还未消失时，无效表3-2键盘说明表图文件为了方便说明和用户使用，会插入各种图文件，图的大小由图内文字大小决定，相同规格的图大小应一致，大图版式一般建议使用嵌入式，小图建议采用四周型，根据实际情况自选，保证图、字显示清楚，整洁。图号按章顺序编号，如图3-2为第三章第二图。编号后空一格显示图名称，编号和名称的位置为该图的正下方居中，字体为宋体5号，段落为段前0.5行，段后0.5行，单倍行距。如图3-4所示。图3-4理念封三封三页采用图3-4图标，图片高度设定为4cm，版式四周型，居中，位于页面三分之一处。封底封底是文件的最后部分，文件封底包括公司中英文全称、公司地址、邮编、总机、业务联系、技术支持、传真、公司网址等信息。其中《技术说明书》、《用户手册》、《配置手册》三类文件采用统一的封底，具体参见A.5封底示例。打印《技术说明书》、《用户手册》、《配置手册》三类文件打印时选取A4纸张，页面设置为书籍折页，手动双面打印。注意：正面打印完成后需将纸张倒序，将纸张按要求放入打印机纸盒内，继续打印反面。《设计文档》、《考察研究报告》、《输入文件》、《标书》四类文件打印无需特殊设置，如需双面打印，则选择手动双面打印。A.1技术文件封面示例文件编写规范文件编号生效日期071205受控编号保密级别版本号V0.1修改状态总页数正文附录编制审核批准(版权所有,翻版必究)A.2变更日志示例变更日志编号版本修改内容修改人修改日期1V1.01项目编号修改，目录修改。张玮0901212V1.02内容校核、调整。赵航宇090311A.3扉页示例XXXX股份有限公司投标文件版本：V1.022007年11月A.4目录目录1 编写目的 32 适用范围 23 文件编制规范 33.1 文件的结构 33.2 文件的版面 43.3 封面 43.3.1 技术说明书、用户手册、配置手册、标书封面 43.3.2 设计文档、考察研究报告、输入文件封面 43.4 变更日志 53.5 扉页 53.6 目录 63.7 正文 63.7.1 页眉和页脚 63.7.2 各级标题 63.7.3 正文内容 73.7.4 表格文件 73.7.5 图文件