第五章--详细设计说明书-案例3.docVIP

详细设计说明书编写规范 文件编号: 编制 日期 审核 日期 审批 日期 XX公司 目 录 目 录 1 1. 引言 2 1.1. 读写对象 2 1.2. 项目背景 2 1.2.1. 基本说明 2 1.2.2. 考标准和业务技术规范 3 1.2.3. 相关系统 3 1.3. 编写目标 3 1.4. 编写原则 3 1.5. 定义 3 1.6. 参考资料 3 2. 软件结构 3 2.1. 软件结构图 3 2.2. 模块子结构图 3 2.3. 模块清单 3 3. 模块设计 4 3.1. 模块1 （标识符） 4 3.1.1. 模块概述 4 3.1.2. 功能和性能 4 3.1.3. 输入/输出项 4 3.1.4. 数据结构 4 3.1.5. 算法 5 3.1.6. 限制条件 5 3.1.7. 测试计划 5 3.2. n 模块n （标识符） 5  引言 写详细设计进行的基础，遵照的规范，例如：按IS09000质量控制体系标准，遵循《中华人民共和国国家标准》 写编写目的，例如：《xx系统详细设计说明书》是详细设计阶段成果的重要组成部份。详细设计文档是编码阶段的工程蓝图，编码阶段将基本遵循详细设计说明书对各模块的详细设计，进行程序代码的生成，详细设计可分为服务器（Server）端的后台程序和客户机（Client）端的前台程序。以及界面设计，详细设计是程序编码的基本依据。详细设计说明书将作为“xx系统”的系列规范文档之一。 读写对象 详细设计说明书文档的读者对象是： 对相关业务技术和总体方案作出决策的管理人员和质量管理人员； 对本《详细设计》进行评审和确认的有关业务，技术人员 参加编码阶段工作的全体软件工程师 参加系统测试的全体软件工程师 参加试运行的全体软件工程师 xx系统项目组，其他有权需要调用本文档的人员 《xx系统详细设计说明书》的全部内容为公司、xx用户方的商业机密，应严格控制业务范围，项目开发阶段由设计部、项目软件开发组负责管理，项目结束后交由公司或研究所档案室负责管理，未经双方同意，不得以任何介质（文本，软盘，硬盘，光盘）等形式持有本文档 部分或全部内容。 项目背景 基本说明 系统说明： 系统简称： 项目代号： 委托单位： 开发单位： 主管部门： 考标准和业务技术规范 相关系统 编写目标 编写本系统详细设计说明书主要目标是为软件开发工程师编码，配测工程师系统测试，系统维护工程师系统维护提供的基本技术资料。 编写原则 编写详细设计说明书原则是力求详尽，以为软件开发工程师提供详尽的编码依据 细说明书以流程图和结构话语言表达或伪代码表述，为编码阶段提供明快的编程 信息 定义 详细设计说明书中所涉及的专门术语，关键词缩写等内容，请参阅《需求分析说明书》，《概要设计说明书》。对《详细设计说明书》增加的有关专门术语： 参考资料 例如： 本节以列表或排序的方式给出概要设计中所涉及到的重要的参考资料的名称、作者、出版日期等信息。 软件结构 软件结构图 模块子结构图 模块清单 编号 模块名称 模块标识符 父模块标识符 1 视图选择匹配模块 View-Match / 2 读入视图模块 ViewFile 3 词法分析模块 LEX 4 查询提交模块 Commit 模块设计 模块1 (View-Match) 模块概述 对于一个查询，找到匹配的视图，并且输出结果。 功能和性能 3.1.2.1 功能（IPO图） 输入 处理 输出 视图集合{V}，查询Q 在视图集合中找到与查询匹配的视图，并且计算结果 用视图替换基表以后新的查询表达式 3.1.2.2 性能 输入/输出项 3.1.3.1 输入项 名称 标识符 类型 介质 来源 描述 视图集合 {V} 字符串数组集合 磁盘 存储介质或键盘输入 / 查询 Q 字符串数组集合 磁盘 存储介质或键盘输入 / 3.1.3.1 输出项 名称 标识符 类型 介质 来源 描述 新的查询表达式 Q’ 字符串数组集合 内存 处理结果 / 数据结构 3.1.4.1全局数据结构 名称 标识符 类型 使用方式 访问方式 描述 属性列表 List 链表 struct List { char * text; List * Next;} 属性列表 ColList 链表 struct ColList { List * Lst; ColList* next;} 表达式 ExpList 链表 struct ExpList {char * alias; ColList * Lst; List * TextStr; ExpList * Next;} 返回值