28模块开发卷宗编写大纲.docVIP

创智软件园 ISO9001质量体系作业文件 名 称 模块开发卷宗编写大纲 编 号 PRS/QWF-28-1999 版 号 B/1 拟 制 刘立军 日 期 1999/10/20 审 核 日 期 批 准 日 期 生效日期 1999/10/25 受控状态 发文号 目录 1 引言 1 1.1 编写目的 1 1.2 读者对象 1 1.3 项目背景 1 1.4 定义 1 1.5 参考资料 1 1.6 变更历史 2 2 模块开发说明 2 2.1 模块1开发情况 2 2.1.1 模块开发测试情况表 2 2.1.2 模块功能说明 3 2.1.3 模块设计说明 3 2.1.4 面向过程的源代码清单（可选） 3 2.1.5 面向对象的源代码清单（可选） 3 2.1.6 测试说明 4 2.1.7 复审的结论 4 2.2 模块2开发情况 4 2.3 模块N开发情况 4 引言 编写应用系统模块开发卷宗的总体目标是为运行维护阶段提供关于应用系统的内部结构的技术文档，以便于系统与编码相关的日常维护完善工作。 模块开发卷宗是在模块开发过程中逐步编写出来的，每完成一个模块或一组密切相关的模块时编写一份，应该把所有的模块开发卷宗汇集在一起。编写的目的是记录和汇总低层次开发的进度和结果，以便于对整个模块开发工作的管理和复审，并为将来的维护提供非常有用的技术信息。 模块开发卷宗在开发阶段的定版时间必须位于经过测试之后。运行维护阶段的修改和完善工作的历史信息必须在本开发卷宗得以记录和体现。 具体的内容要求如下。 编写目的 简要说明编写本模块开发卷宗的目的。 读者对象 简要说明本模块开发卷宗可能的合法读者对象。 项目背景 简要说明关于本项目的项目名称、简称、项目代号、版本号、委托单位、开发单位和主管部门、开发完工时间、该软件系统与其它系统的关系等背景信息。 定义 简要说明本模块开发卷宗中涉及的专门术语、容易引起歧义的概念、关键词缩写及其他需要解释的内容。 参考资料 可包括： 项目经审核的计划书、合同、或上级机关的批文； 文档所引用的资料、标准和规范。 需求规格说明书。 概要设计说明书。 详细设计说明书。 数据库设计说明书。 其他参考的资料。 以列表或排序的方式给出参考资料的名称、作者、单位、出版日期、地点、联系方式或详细说明资料来源等信息。 变更历史 序号 人员 日期 变更详情 刘立军 1999．09．30 初稿 模块开发说明 模块1开发情况 模块开发测试情况表 应用软件系统名称 子系统名称 模块名称 软件项标识符 模块编码 编制者 起止日期 模块测试 测试人员 起止日期 组装测试 测试人员 起止日期 模块维护 维护人员 起止日期 源代码行数 目标模块大小 项目负责人签字 批准日期 模块功能说明 扼要说明本模块(或本组模块)的功能，主要是IPO（输入、处理、输出）。可以从概要或详细设计说明书中摘录。同时列出在软件需求规格说明书中对应这些功能说明的章、条、款。 模块设计说明 说明本模块(或本组模块)的设计考虑，包括： A．在概要设计说明书中有关对本模块（或本组模块）设计考虑的叙述，包括本模块在软件系统中所处的层次，它同其他模块的接口； B．在详细设计说明书中有关对本模块(或本组模块)的设计考虑，包括本模块的算法、处理流程、牵涉到的设计限制、驱动方式和出错信息等。 面向过程的源代码清单（可选） 此处给出具体的开发工具的名称、版本号、开发环境配置等。 源代码清单的格式： 说明部分 //*********************************** 过程英文名称：。。。 。。。 过程功能：。。。 。。。 过程的输入参数的名称、数据类型、顺序位置等：。。。 。。。 过程的输出参数的名称、数据类型、顺序位置等：。。。 。。。 过程的处理过程说明：文字形式排序列举 所调用的过程或函数或其他模块的名称及调用的方式 调用本模块的其他过程或函数的名称及被调用的方式 *************************