软件开发文档.pptxVIP

《信息系统监理师》; 中共党员、北京理工大学博士、多所大学客座教授 多次参与全国计算机技术与软件专业技术资格(水平)考 试的命题与阅卷 全国计算机技术与软件专业技术资格(水平)考试辅导用书 编委会主任 主编的《信息系统监理师教程（第2版）》已作为全国计算机技术与软件专业技术资格（水平）考试用书 主编的《信息系统监理工程师手册》已作为监理行业的工作指导手册 参编的信息系统工程监理规范(GB/T 19668改版)已作为国家标准;19.8　软件开发文档 19.8.1　文档的种类 在软件开发过程中，承建单位需要根据软件关键等级和软件规模等级的不同，有选择地产生下列文档，选择原则详见19.8.3节。 GB8567－88《计算机软件产品开发文件编制指南》中规定，在软件的开发过程中，一般地说，应应该产生14种文件。这14种文件是： 可行性研究报告； 项目开发计划； 软件需求说明书； 数据要求说明书； 概要设计说明书； 详细设计说明书； 数据库设计说明书；;用户手册； 操作手册； 模块开发卷宗； 测试计划； 测试分析报告 开发进度月报； 项目开发总结报告。 GB8567－88《计算机软件产品开发文件编制指南》提出了在软件开发中文件编制的要求，但并不意味这些文件都必须交给业主。业主应应该得到的文件的种类由承建单位与业主之间签订的合同、合同附件或其他具有同等效力的文件规定。;19.8.2　文档的结构 1. 　封面格式 图19.6是封面的参考格式。 2.　修改页 记录软件或文档从第一版本以来所有的修改情况。记录内容应包括版本号、日期、所修改章节、所修改页、备注等项目。 3.　目录编写要求 目录的内容包括章节、图表和附录的编号、标题及其所在页的页码。标题与页码之间用符号“……”连接。目录应另编面码，不与正文部分和附录部分的页码连接。 4.　正文编写要求 文档正文除对规定的内容进行合理取舍外，在特别需要时，可以在有关章、节之后加入“其他说明”，并按顺序编章、节号。;5.　注释编写要求 注释应包括能帮助了解该文档和各种信息（如背景信息、词汇表），及该文档所用的全部术语和缩略语及其定义;6.　附录编写要求 附录提供为使文档内容更加完整而单独列出的信息（如图、分类数据等）。每个附录都应在文档的正文中被引用。为方便起见，这些附录也可单独装订。这些附录应按字母顺序（Ａ、Ｂ等分类，并且每个附录中的小节编号均须加上附录字母（如附录Ａ的Ａ１、Ａ２等）。每个附录中的页也可单独编页码。 19.8.3　文档的取舍与合并 　　1.　文档的取舍方法 可根据各系统或子系统软件安全性关键等级和软件规模等级选择取舍有关软件件文档。“系统/子系统设计文档”以及“软件开发计划”编写完成后，系统或子系统的设计部门要对软件提出软件功能和软件质量的要求。 从“软件需求说明”以及之后的文档要由承建单位编写。表19－5是文档的取舍与合并的指导性原则，表中表明的是至少要求的文档的种类。;注：当软件同时适用于几个类别时，按最高的要求处理。 规模和关键等级的划分见“总装备部计算机软件研制工作管理要求”。 表格说明： √ ：选取， ●：可合并，　　　　 剪刀：可拆分，　　 ﹡：根据需求选取。;2. 文档的拆分 当被开发系统的规模非常大（如源码超过一百万行）时，一种文件可以分成几卷编写，可以按每一个系统分别编制，也可以按内容划分成多卷，例如 项目开发计划可能包括： 质量保证计划 配置管理计划 　　　　　　　　　　　 用户培训计划 　　　　　　　　　　　　安装实施计划 系统设计说明书可分写成：系统设计说明书 　　　　　　　　　　　　子系统设计说明书 程序设计说明书可分写成：程序设计说明书 　　　　　　　　　　　　接口设计说明书 　　　　　　　　　　　　版本说明;操作手册可分写成：操作手册 　　　　　　　　　安装实施过程 测试计划可分写成：测试计划 　　　　　　　　　测试设计说明 测试规程 测试用例 测试分析报告可分写成：综合测试报告 　　　　　　　　　　　验收测试报告 项目开发总结报告可分写成：项目开发总结报告 　　　　　　　　　　　　　资源环境统计;　3.　裁剪说明 裁剪是指对某个文档的具体章、节或子节的取舍，若某章、节或子节被裁剪，只需在该节注明：“此章（节）无内容”即可。若裁剪的是整节（包括其所有子节），则只需在最高层的节标题中加以说明。 4.　有关引用文件 各文档中都规定了要列写的引用文件。为避免信息冗余，只有当文档切实引用了更高一层的说明或交叉引用其他有关文件的具体章、节、图表等信息时，才列写引用文件。避免无目的地列写许多没有实际应用的文件。;谢谢大家