软件开发文件编制(「干货」拿来即用的软件成熟文档编制规范)

　　1 引言1.1 目的

　　本文档编制指南的目的是为了指导CMMI文档的编写。

　　1.2 适用范围

　　本文档适用于EPG成员编写OSSP文档以及相关部门软件项目组成员编写项目文档指南。

　　1.3 术语和缩略语

　　术语、缩略语

　　解释

　　EPG

　　Engineering Process Group，工程过程组

　　OSSP

　　Organizations Set of Standard Process，组织标准过程集

　　2 文档标识规则2.1 文档体系结构

　　文档体系结构

　　2.1.1 组织级的方针/策略文档

　　指组织或项目为实施 OSSP 定义的相关活动所必须遵循的书面管理策略、制度或约定。

　　2.1.2 过程文档

　　对某一过程域涉及的所有活动以及活动之间的依赖关系和次序的综合描述。是对该过程域活动的一个综合指导。

　　2.1.3 规程/规范/标准/指南文档

　　对某一个过程涉及的某一个具体活动的详细的指导说明。为了实现这一活动的具体目标，它提供了“谁（WHO）应该在什么时候（WHEN）做什么事（WHAT） ”的具体的方法（HOW）和/或做事的标准（准则）。

　　2.1.4 模板/表单/检查列表/工具

　　模板是所有过程、规程的输入、输出结果或数据的载体，是组织或项目按照过程、规程、规范执行相关活动的最有力的证明，也是软件过程资产成果或数据最直接的来源。同时包含了过程资产、检查列表、工具实体。

　　2.2 文档标识方法2.2.1 公司标识

　　统一使用公司名称“*****信息技术有限公司”。

　　2.2.2 文档类别

　　类别名称

　　标识

　　说明

　　3 Word文档的编制3.1 文档组成结构

　　一般情况下文档应由下列部分构成：

　　1) 封面（保密级别、文档名称、公司名称）具体形式参照本文档封面。

　　2) 版本历史（应包含日期版本说明作者）

　　3) 目录（至少到二级目录）

　　4) 引言（包含编写目的适用范围术语及其缩略语以及必要的参考文献）

　　5) 正文（可参照OSSP中具体文档模板）

　　6) 附录（与本文档相关的重要公式流程等的说明）

　　3.2 文档编排格式3.2.1 总则

　　各文档的编排格式应统一。

　　3.2.2 封面

　　封面由文档名称、密级、公司名称等几部分组成。文档密级位于封面左上角，文档名称和公司名称居中对齐。

　　3.2.3 目录

　　目录中的标题按级别缩进，页面编号靠右对齐。

　　3.2.4 正文

　　正文首行缩进2个汉字的距离，正文采用五号或小四字号。

　　3.2.5 图、表

　　表格中标题行的背景应为灰色。请选用表格设计中具栏中——表样式中的“表格标题”。

　　3.2.6 附录

　　每个附录应另起一面。第一个附录编号为附录 A，以后各附录按字母顺序依此往下编排。

　　3.3 文档中的字号和字体

　　序 号

　　页 别

　　位 置

　　文字内容

　　字号和字体

　　1

　　封面

　　左上第一行

　　密级

　　五号宋体

　　2

　　封面

　　第3-5行

　　文档标题

　　二号宋体加粗

　　3

　　封面

　　倒数第3-5行

　　公司名称

　　四号宋体

　　4

　　变更记录

　　第二页第一行

　　变更记录

　　三号黑体

　　5

　　变更记录

　　表格中

　　变更信息

　　小四宋体

　　6

　　目录

　　第一行

　　目录

　　三号宋体加粗

　　7

　　目录

　　目录内容

　　五号或小四宋体

　　8

　　正文各页

　　正文

　　五号或小四宋体

　　9

　　正文各页

　　一级标题

　　二号宋体加粗

　　10

　　正文各页

　　二级标题

　　小二宋体加粗

　　11

　　正文各页

　　三级标题

　　三号宋体加粗

　　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-DD，如2012-12-10或2012/12/10。

　　4 Excel文档的编制4.1 文档组成结构

　　一般情况下，文档应由下列部分构成：

　　1） 封面（文档名称，修订记录）。

　　2） 正文

　　4.2 文档的编排格式4.2.1 封面

　　封面由文档名称、版本号、修订记录等及部分组成。

　　4.2.2 修订记录

　　修订记录一般包括：版本号、日期、编写、审核、批准等信息。

　　4.2.3 正文

　　正文字号一般采用10号或12号。

　　正文根据情况进行窗口冻结。

　　4.2.4 页面设置

　　打印文档一般采用A4纸幅面（21厘米X29.7厘米）。

　　在特殊情况下（如图、表不能缩小时），文档幅面允许根据实际需要延长和加宽，倍数不限。

　　打印文档必须设置纸张方向，具体使用纵向还是横向根据文档内容设置。

　　打印文档需调整好打印区域，并预览效果，保证打印内容的完整和友好。