软件工程详细设计文档模板.doc

软件开发中心 Software Development Center 详细设计说明书 项目名称 文档类别 文档编号 版 本 密 级 二二 一八二一八二 一八年十一月二十四日一八年十一月二十四日 编号题目 项目类别版本 V1 0 时间 2018 11 24 第 2 页 共 17 页 版本修订记录 版本日期描 述作者审核 编号题目 项目类别版本 V1 0 时间 2018 11 24 第 3 页 共 17 页 目目 录录 1引言引言 3 1 1 编写目的 3 1 2 项目概况 3 1 3 术语定义 3 1 4 参考资料 3 2系统概述系统概述 3 2 1 系统体系结构 3 2 2 系统功能分布和层次结构 3 3程序设计详细描述程序设计详细描述 3 3 1 客户开销户分类 SP05210102 设计说明 3 4公用接口程序设计说明公用接口程序设计说明 3 4 1 全局变量 3 4 2 公用界面 3 4 3 公用函数和过程 3 4 4 公用表辞典 3 附件附件 3 编号题目 项目类别版本 V1 0 时间 2018 11 24 第 4 页 共 17 页 1 引言引言 1 1 1 1 编写目的编写目的 简要说明编写这份详细设计说明书的目的 指出预期的读者 本详细设计说明书的编写目的是为了说明程序系统的各个层次中的每个软件对象 包 括每个模块和程序 的设计考虑 以向系统实现 编码和测试 阶段提供关于程序系统实 现方式的详细描述 从而成为编码的技术基础 本详细设计说明书的适用读者为 软件开发者 测试人员 1 2 1 2 项目概况项目概况 1 说明待开发的软件系统的名称 2 列出本项目的任务委托单位 开发单位 协作单位 用户单位 3 说明项目背景 叙述该项软件开发的意图 应用目标 作用范围以及其他应向读者 说明的有关该软件开发的背景材料 如果本次开发的软件系统是一个更大的系统的一个组 成部分 则要说明该更大系统的组成和介绍本系统与其它相关系统的关系和接口部分 4 保密说明 本项为可选项 一般的软件公司都会要求对软件开发的概要设计文档进行保密 不允 许被复制 使用和扩散到公司之外的范围 如果需要强调则允许做相关的保密说明 5 版权说明 本项为可选项 若有必要 才要作有关的描述 1 3 1 3 术语定义术语定义 列出本文档中所引用到的专门术语的定义和首字母缩写词 缩略语的原文 以便对详 细设计说明书进行适当的解释 编号题目 项目类别版本 V1 0 时间 2018 11 24 第 5 页 共 17 页 1 4 1 4 参考资料参考资料 列出所本文档所使用的参考资料 包括 A 本软件开发所经核准的合同或标书或可行性报告等文档 B 软件开发计划书 C 需求分析报告 D 测试方案 若存在初稿的话 E 概要设计说明书 F 与本项目有关的已发表的文件或资料 G 本文件中各处引用的文件 资料 所采用的软件开发标准和规范 注意 必须列出文件 资料的作者 标题 编号 发表日期和出版单位 以说明这些 文件资料的来源 若某些文档有保密要求的 则要说明其保密级别 2 系统概述系统概述 概要地介绍本软件系统 只要求提供影响详细设计的一般因素 不必太详细地描述大 量细节 本章主要目的仅仅是使本详细设计说明书更加易于理解 建议根据系统设计的实 际需要可以有选择地从以下方面进行概要描述 系统体系结构 系统功能分布和层次结构 程序实现风格或方式 2 1 2 1 系统体系结构系统体系结构 画出系统的体系结构图 以说明系统体系结构的实现技术 所用到的数据库主体的描 述 如何实现访问数据库 如何划分程序的主体部分 2 2 2 2 系统功能分布和层次结构系统功能分布和层次结构 主要介绍本软件系统程序组织的结构 包括各个功能模块的划分 可以用模块层次结 编号题目 项目类别版本 V1 0 时间 2018 11 24 第 6 页 共 17 页 构图来表示 以说明各个模块之间的相互调用关系 或者也可以用一系列的图表来列出本 程序系统内的每个程序 包括各个模块或子程序 的名称 标识符和它们之间的层次结构 关系 程序组织的层次结构关系可用表格形式进行描述 建议如下表 模块名称模块编号子模块名称功能说明子模块编号 3 程序设计详细描述程序设计详细描述 从本章开始 逐个地给出程序组织结构中各个层次的每个程序的设计考虑 每一程序 模块的详细设计描述单独为一节 标题格式为 模块名称 模块编号 设计说明 例如 3 1 主界面 untMsgMain frmMsgMain 000101 设计说明 对每个程序模块 包括存储过程的设计 建议分别从以下几个方面进行描述 注明该功能模块的编号和模块名称 模块功能简述 界面 包括屏幕编号 屏幕图片 控件说明 所调用的模块 包括控件 的说明 变量说明 函数 过程列表 函数 过程说明 包括输入 输出和处理逻辑 测试要求 主要说明本模块进行单元测试的要点或注意事项 出错处理 编号题目 项目类别版本 V1 0 时间 2018 11 24 第 7 页 共 17 页 尚未解决的问题 参考以下范例 允许根据实际需要进行裁剪 3 1 3 1 客户开销户分类客户开销户分类 Sp05210102 Sp05210102 设计说明设计说明 模块编号052 盘后查询 源程序文件Sp05210102源程序名称客户开销户分类 功能查询客户的开销户情况汇总 包括开户数 销户数 正常客户 源码类型后台 SP相关源程序文件khkxhfl05210102 jsp 修改历史纪录修改人日期描述 XieYing05 22 2000Initial 被调用模块Web 前台khkxhfl05210102 jsp 调用模块 输入参数iyybdmChar 3 营业部代码 iksrqChar 8 开始日期 ijsrqChar 8 结束日期 输出参数oerrorChar 20 错误代码 otextChar 100 错误信息 结果集列表Numeric柜台开户数 Numeric柜台销户数 Numeric条码开户数 Numeric条码销户数 Numeric银行开户数 Numeric银行销户数 Numeric沪 A 股开户数 编号题目 项目类别版本 V1 0 时间 2018 11 24 第 8 页 共 17 页 模块编号052 盘后查询 源程序文件Sp05210102源程序名称客户开销户分类 Numeric沪 A 股销户数 Numeric深 A 股开户数 Numeric深 A 股销户数 Numeric沪 B 股开户数 Numeric沪 B 股销户数 Numeric深 B 股开户数 Numeric深 B 股销户数 数据域说明临时表要访问的表要做修改的表 客户基本资料 Khjbzl 股东代码表 Gddmb 客户条码 khtm 客户银行帐号 Khyhzh 报表 提示信息 备注 逻辑处理说明分解参数 包括参数出错处理 调用 SP WEBMENUCHK 传入参数 ibycs4 userid ibycs5 菜单 代码 ibycs6 password ibycs7 客户端 IP 执行权限校验 获得其返回 参数 oerror otext 3 If SP WEBMENUCHK 的返回参数 oerror CCS0000 then 把 SP WEBMENUCHK 的返回参数 oerror otext 分别赋给 此 sp 的返回参数 oerror otext 并返回 End program 编号题目 项目类别版本 V1 0 时间 2018 11 24 第 9 页 共 17 页 模块编号052 盘后查询 源程序文件Sp05210102源程序名称客户开销户分类 Else 3 1 计算数据 柜台开户 SELECT COUNT FROM 客户基本资料 KHJBZL WHERE 开户时间前 8 位 满足 输入日期或日期段 AND 营业部代码 输入的营业部代码 柜台销户 SELECT COUNT FROM 客户基本资料 KHJBZL WHERE 销户时间前 8 位 满足 输入日期或日期段 AND 营业部代码 输入的营业部代码 银行开户 SELECT COUNT FROM 银行表 客户银行帐号 KHYHZH WHERE 开户时间前 8 位 满足 输入日期或日期段 AND 营业部代码 输入的营业部代码 银行销户 SELECT COUNT FROM 银行表 客户银行帐号 KHYHZH WHERE 销户时间前 8 位 满足 输入日期或日期段 AND 营业部代码 输入的营业部代码 编号题目 项目类别版本 V1 0 时间 2018 11 24 第 10 页 共 17 页 模块编号052 盘后查询 源程序文件Sp05210102源程序名称客户开销户分类 条码开户 SELECT COUNT FROM 客户条码表 KHTM WHERE 开户时间前 8 位 满足 输入日期或日期段 AND 营业部代码 输入的营业部代码 条码销户 SELECT COUNT FROM 客户条码表 KHTM WHERE 销户时间前 8 位 满足 输入日期或日期段 AND 营业部代码 输入的营业部代码 深 A 股开户 SELECT COUNT FROM 股东帐号表 GDDMB WHERE 开户时间前 8 位 满足 输入日期或日期段 AND 市场代码 2 深 A AND 营业部代码 输入的营业部代码 深 A 股销户 SELECT COUNT FROM 股东帐号表 GDDMB WHERE 销户时间前 8 位 满足 输入日期或日期段 AND 市场代码 2 深 A 编号题目 项目类别版本 V1 0 时间 2018 11 24 第 11 页 共 17 页 模块编号052 盘后查询 源程序文件Sp05210102源程序名称客户开销户分类 AND 营业部代码 输入的营业部代码 深 B 股开户 SELECT COUNT FROM 股东帐号表 GDDMB WHERE 开户时间前 8 位 满足 输入日期或日期段 AND 市场代码 4 深 B AND 营业部代码 输入的营业部代码 深 B 股销户 SELECT COUNT FROM 股东帐号表 GDDMB WHERE 销户时间前 8 位 满足 输入日期或日期段 AND 市场代码 4 深 B AND 营业部代码 输入的营业部代码 沪 A 股开户 SELECT COUNT FROM 股东帐号表 GDDMB WHERE 开户时间前 8 位 满足 输入日期或日期段 AND 市场代码 1 沪 A AND 营业部代码 输入的营业部代码 沪 A 股销户 SELECT COUNT 编号题目 项目类别版本 V1 0 时间 2018 11 24 第 12 页 共 17 页 模块编号052 盘后查询 源程序文件Sp05210102源程序名称客户开销户分类 FROM 股东帐号表 GDDMB WHERE 销户时间前 8 位 满足 输入日期或日期段 AND 市场代码 1 沪 A AND 营业部代码 输入的营业部代码 沪 B 股开户 SELECT COUNT FROM 股东帐号表 GDDMB WHERE 开户时间前 8 位 满足 输入日期或日期段 AND 市场代码 3 沪 B AND 营业部代码 输入的营业部代码 沪 B 股销户 SELECT COUNT FROM 股东帐号表 GDDMB WHERE 销户时间前 8 位 满足 输入日期或日期段 AND 市场代码 3 沪 B AND 营业部代码 输入的营业部代码 股东开户 沪 A 股开户 深 A 股开户 沪 B 股开户 深 B 股开户 股东销户 沪 A 股销户 深 A 股销户 沪 B 股销户 深 B 股销户 编号题目 项目类别版本 V1 0 时间 2018 11 24 第 13 页 共 17 页 模块编号052 盘后查询 源程序文件Sp05210102源程序名称客户开销户分类 if 取数据出错 then 非 CCS0000 的错误代码赋值给本 sp 的返回参数 oerror 出错信息返回给本 sp 的返回参数 otext 返回参数 end program else if 没有取到数据 该数据强制为其缺省值 3 2 取表 Cxtjlsb 中 字段 序列号 的最大值 并加 1 作为此 次插入的一批数据的序列号 insert 序列号 柜台开户数 柜台销户数 条码开户数 条码销户数 银行开 户数 银行销户数 股东开户数 沪 A 股开户数 深 A 股开户数 沪 B 股开 户数 深 B 股开户数 Into Cxtjlsb declare cursor for select 柜台开户数 柜台销户数 条码开户数 条码销户数 银行开户数 银 行销户数 股东开户数 沪 A 股开户数 深 A 股开户数 沪 B 股开户数 深 B 股开户数 Where 表中字段 序列号 此批插入数据的序列号 open cursor 3 5 把 SP WEBMENUCHK 的返回参数 oerror otext 分别赋给 编号题目 项目类别版本 V1 0 时间 2018 11 24 第 14 页 共 17 页 模块编号052 盘后查询 源程序文件Sp05210102源程序名称客户开销户分类 此 sp 的返回参数 oerror otext 并返回 3 6 end program 输入界面屏幕编号 05210102a 主要控件说明 输出界面屏幕编号 05210102b 编号题目 项目类别版本 V1 0 时间 2018 11 24 第 15 页 共 17 页 模块编号052 盘后查询 源程序文件Sp05210102源程序名称客户开销户分类 主要控件说明 测试要求 出错处理 遗留问题 4 公用接口程序设计说明公用接口程序设计说明 给出各类公用接口的程