A2010-0000-01.文档编写规范.docVIP

文档编写规范 北京航空航天大学 2010-09 版本变更历史 版本 提交日期 主要编制人 审核人 版本说明 项目组成员分工及完成情况说明 说明 项目组成员：成员姓名和学号 任务分工和完成情况：在本文档编制过程中，每个成员的职责、承担的具体工作内容及其完成情况的说明； 协作情况：共同研讨、论证和评审等项目组会议或网上协作（如研讨和意见交流）等，以及每个成员的贡献。 任务编号 任务名称 具体工作内容说明 承担人 完成情况 贡献率 （%） 目 录 1. 范围 1 1.1 标识 1 1.2 文档概述 1 1.3 术语和缩略词 1 2. 引用文档 1 3. 文档标识 2 4. 文档撰写格式要求 2 范围 标识 文档标识号：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. ”，编号后面加英文字体的“.”，再留一个空格后为表名字（其格式采用“表编号”的样式）。 建模要求 每个项目组需根据项目特点，确定一种开发方法，比如面向对象方法或者结构化方法，并据此明确在建立需求模型和设计模型时，应当采用UML模型或者结构化方法的常用模型； 在需求规格说明书中，应当建立必要的模型来描述应用领域中涉及到的相关概念、规则和特性等。比如， 如果采用面向对象方法，通常： 应当使用用例图来描述系统的各类用户和他们所需要的典型用例，并给出用例的详细定义，包括可以采用顺序图来描述主场景等； 使用活动图来描述业务流程； 使用类图来描述各类用户的特定及其相互关系； 使用类图来描述领域相关的各种概念及其内涵和相互关系，以及必要的约束规则等； 使用状态图来描述系统的运行状态和控制规则等。 如果采用结构化方法，通常： 采用数据流图来描述系统的信息处理流程； 采用ER模型来描述数据的关联； 采用控制流图或状态图等方法来描述系统状态的控制规则等。 在这些方法中，都需建立数据词典，对于模型中给出的术语进行定义和说明； 在设计文档中，应当建立必要的模型来描述系统的结构，以及静态和动态特性等。 如果采用面向对象方法，通常： 使用类图来描述系统（包括子系统和构件）的内部构成成分和逻辑结构，以及必要的约束规则等； 使用活动图来描述系统的工作流程； 使用状态图来描述系统的运行状态和控制规则等。 使用顺序图