A2010-00-00-01文档编写规范.doc

PAGE 2 文档编写规范 北京航空航天大学 2010-09  版本变更历史 版本提交日期主要编制人审核人版本说明 项目组成员分工及完成情况说明 说明 项目组成员：成员姓名和学号 任务分工和完成情况：在本文档编制过程中，每个成员的职责、承担的具体工作内容及其完成情况的说明； 协作情况：共同研讨、论证和评审等项目组会议或网上协作（如研讨和意见交流）等，以及每个成员的贡献。 任务编号任务名称具体工作内容说明承担人完成情况贡献率 （%） PAGE I 目 录  TOC \o 1-3 \h \z \u  HYPERLINK \l _Toc274980766 1. 范围  PAGEREF _Toc274980766 \h 1  HYPERLINK \l _Toc274980767 1.1 标识  PAGEREF _Toc274980767 \h 1  HYPERLINK \l _Toc274980768 1.2 文档概述  PAGEREF _Toc274980768 \h 1  HYPERLINK \l _Toc274980769 1.3 术语和缩略词  PAGEREF _Toc274980769 \h 1  HYPERLINK \l _Toc274980770 2. 引用文档  PAGEREF _Toc274980770 \h 1  HYPERLINK \l _Toc274980771 3. 文档标识  PAGEREF _Toc274980771 \h 2  HYPERLINK \l _Toc274980772 4. 文档撰写格式要求  PAGEREF _Toc274980772 \h 2  公共文档 文档编写规范 PAGE 4 范围 标识 文档标识号：A2010-00-00-01 文档标题：项目文档编写规范 版本号：1.0 文档概述 本文档为给出了本项目所涉及所有文档的公共编写规范，包括文档排版规范、图表规范、文档命名规范等内容。 术语和缩略词 SRS：软件需求规格说明书（System Requirement Specification） SDD：系统设计说明书（System Design Description） STR：系统测试报告（System Testing Report） SUM：系统用户手册（System User Manual） 引用文档 GB-T 8567-2006计算机软件文档编制规范，国标 文档标识 本项目每份内部和外部文档均有统一的标识号，其命名规则为：年度编号-2位系统标识号-2位小组编号-2位子文档编号，其中： 项目年度编号均为“A2010”，即2010年项目文档，表3-1给出了其它编号规则的一个示例。 表3-1. 文档表示号编码规则 编号位编号项编号规则2位系统标识号第1小组01第2小组02第3小组03第4小组04第5小组05…………2位文档编号软件需求规格说明书01软件设计说明02软件测试报告03软件用户手册04项目开发总结00其它文档…2位版本编号如果上述几类文档仅为一个版本，则该编号为00；如果有多个版本，则按照01~09的顺序为文档版本号示例：如第1小组的软件需求规格说明书文档编号为：A2010-01-01-00，软件测试报告的第二个版本文档编号为：A2010-01-03-01。 文档撰写格式要求 各子系统必须按照要求为每个子系统编制：需求规格说明书、软件设计说明、软件测试报告、用户手册、项目开发总结至少5份文档。相关文档的格式参见个文档模板。主要注意的几点： 尽量使用文档中已有的样式排版。目前文档中已经提供了各级标题、图编号、表编号的基本样式。 正文格式：宋体（英文为Times New Roman），小四，1.5倍行距，首行缩进两个字符。 图格式：图形要居中，不需要缩进，图中的字体为5号宋体；图按章节编号，写在图形的下方；如第2章的第一幅图应为“图2-1. ”，编号后面加英文字体的“.”，再留一个空格后为图名字（其格式采用“图编号”的样式）。 表格式：表格也居中，表中的文字不需要缩进，表中的字体为5号宋体（英文为Times New Roman），行间距为单倍行距；表也按章节编号，写在表格的上方；如第2章的第一个表应为“表2-1. ”，编号后面加英文字体的“.”，再留一个空格后为表