软件成熟文档编制规范全套.docx

《软件成熟文档编制规范全套.docx》由会员分享，可在线阅读，更多相关《软件成熟文档编制规范全套.docx（10页珍藏版）》请在优知文库上搜索。

1、软件成熟文档编制规范1引言1.1目的本文档编制指南的目的是为了指导CMMI文档的编写。1.2适用范围本文档适用于EPG成员编写OSSP文档以及相关部门软件项目组成员编写项目文档指南。13术语和缩略语术语、缩略解释语EPGEngineeringProcessGroup,工程过程组OSSPOrganizationsSetofStandardProcess,组织标准过程集2文档标识规则2.1文档体系结构2.1.1组织级的方针/策略文档指组织或项目为实施OSSP定义的相关活动所必须遵循的书面管理策略、制度或约定。2.1.2过程文档对某一过程域涉及的所有活动以及活动之间的依赖关系和次序的综合描述。是对该

2、过程域活动的一个综合指导。2.1.3规程/规范/标准/指南文档对某一个过程涉及的某一个具体活动的详细的指导说明。为了实现这一活动的具体目标，它提供了谁（WHO）应该在什么时候（WHEN）做什么事（WHAT）的具体的方法（HOW）和/或做事的标准（准则）。2.1.4模板/表单/检查列表/工具模板是所有过程、规程的输入、输出结果或数据的载体，是组织或项目按照过程、规程、规范执行相关活动的最有力的证明,也是软件过程资产成果或数据最直接的来源。同时包含了过程资产、检查列表、工具实体。2.2文档标识方法2.2.1公司标识统一使用公司名称*信息技术有限公司。2.2.2文档类别类别名称标识说明3Word文档

3、的编制3.1文档组成结构一般情况下文档应由下列部分构成：1）封面（保密级别、文档名称、公司名称）具体形式参照本文档封面。2）版本历史（应包含日期版本说明作者）3）目录（至少到二级目录）4）引言（包含编写目的适用范围术语及其缩略语以及必要的参考文献）5）正文（可参照OSSP中具体文档模板）6）附录（与本文档相关的重要公式流程等的说明）3.2文档编排格式3.2.1总则各文档的编排格式应统一。3.2.2封面封面由文档名称、密级、公司名称等几部分组成。文档密级位于封面左上角，文档名称和公司名称居中对齐。3.2.3目录目录中的标题按级别缩进，页面编号靠右对齐。3.2.4正文正文首行缩进2个汉字的距离，正

4、文采用五号或小四字号。3.2.5图.表表格中标题行的背景应为灰色。请选用表格设计中具栏中一一表样式中的表格标题。3.2.6附录每个附录应另起一面。第一个附录编号为附录A,以后各附录按字母顺序依此往下编排。3.3文档中的字号和字体序号页另U位置文字内容字号和字体1封面左上第一行密级五号宋体2封面第3-5行文档标题二号宋体加粗3封面倒数第3-5行公司名称四号宋体4变更记录第二页第一行变更记录三号黑体5变更记录表格中变更信息小四宋体6目录第一行目录三号宋体加粗7目录目录内容五号或小四宋体8正文各页正文五号或小四宋体9正文各页一级标题二号宋体加粗10正文各页二级标题小二宋体加粗11正文各页三级标题三号

5、宋体加粗12正文各页四级标题四号宋体加粗13正文各页五级标题四号宋体加粗14正文各页图中的数字和文字小五号宋体15正文各页图题、表题五号黑体16正文各表中的文字小五号宋体页17附录第一行附录编号五号黑体18附录第二行附录标题五号黑体19附录附录内容五号或小四宋体20页眉页眉文档名称小五宋体21页脚页脚左侧公司名称小五宋体22页脚页脚右侧页码小五宋体3.4页面布局打印文档一般采用A4纸幅面（21厘米X29.7厘米）。在特殊情况下（如图、表不能缩小时），文档幅面允许根据实际需要延长和加宽，倍数不限。页边距为：上：2.50厘米，下：2.0厘米，左：2.5里面，右：2,0厘米日期格式YYYY-MM-D

6、D如2012-12-10或2012/12/10。4Excel文档的编制4.1文档组成结构一般情况下，文档应由下列部分构成：1）封面（文档名称，修订记录）。2）正文4.2文档的编排格式4.2.1封面封面由文档名称、版本号、修订记录等及部分组成。4.2.2修订记录修订记录一般包括：版本号、日期、编写、审核、批准等信息。4.2.3正文正文字号一般采用10号或12号。正文根据情况进行窗口冻结。4.2.4页面设置打印文档一般采用A4纸幅面（21厘米X29.7厘米）。在特殊情况下（如图、表不能缩小时），文档幅面允许根据实际需要延长和加宽，倍数不限。打印文档必须设置纸张方向，具体使用纵向还是横向根据文档内容设置。打印文档需调整好打印区域，并预览效果，保证打印内容的完整和友好。