《产品名称-详细设计说明书.doc》由会员分享，可在线阅读，更多相关《产品名称-详细设计说明书.doc（11页珍藏版）》请在金锄头文库上搜索。
1、 产品名称产品名称 详细设计说明书详细设计说明书 哈尔滨银行版权所有哈尔滨银行版权所有 内部资料 注意保密 修订历史记录修订历史记录 日期日期说明说明作者作者 填写说明 填写说明 1 文档新增时 该表开始填写 说明本次为新建 不需要填写后续详细修改说明 文档新增时 该表开始填写 说明本次为新建 不需要填写后续详细修改说明 2 产品开发过程中或以后产品升级过程中 每次修改都要在该表中登记主要内容 修改内容直产品开发过程中或以后产品升级过程中 每次修改都要在该表中登记主要内容 修改内容直 接在文档中体现 并在本文档后面依次添加详细修改说明 接在文档中体现 并在本文档后面依次添加详细修改说明 3 表
2、格中每行应为一独立任务 例如产品首次建立时 先是编写 后是评审 评审后根据意见表格中每行应为一独立任务 例如产品首次建立时 先是编写 后是评审 评审后根据意见 再调整等一系列工作 延续的时间可能比较长 仍然只需要填写表中一行 再调整等一系列工作 延续的时间可能比较长 仍然只需要填写表中一行 4 日期日期 填写为本行内容修改开始的日期 填写为本行内容修改开始的日期 5 表中历史内容不应删除 应一直保留 表中历史内容不应删除 应一直保留 目目 录录 第一章第一章 引言引言 4 4 1 1 概述 4 1 2 定义 4 1 3 设计依据 4 第二章第二章 程序设计程序设计 5 5 2 1 模块和程序关
3、系设计 5 2 1 1 功能模块和程序关系表 5 2 1 2 复用说明 5 2 1 2 1 使用组件情况说明 5 2 1 2 2 符合软件复用标准的程序说明 6 2 2 程序详细设计 6 第三章第三章 其它方面的设计考虑其它方面的设计考虑 8 8 3 1 系统出错信息 8 3 2 数据常量和变量设计 8 3 3 配置文件 可选内容 9 3 4 其它方面设计说明 9 附录附录 A A 详细修改说明 详细修改说明 1010 第一章第一章 引言引言 说明 1本文档形成的目的 细化总体设计 为系统实施奠定基础 使开发人员依据详 细设计说明书即可完成编码工作 1 11 1 概述概述 待开发软件系统的名称
4、 1 21 2 定义定义 列出本文中用到的专门术语的定义和外文首字母组词的原词组 1 31 3 设计依据设计依据 列出有关的参考资料 第二章第二章 程序设计程序设计 2 12 1 模块和程序关系设计模块和程序关系设计 在详细设计过程中除非发现功能分析有不合理之处需重新进行功能分析外 不得改变 功能分析的模块设计结果 只是依据功能分析的结果进行程序设计 程序结构设计主要任务是根据功能模块 从实现的角度给出功能模块与程序的对应关 系 划分程序边界 设计结果以下表形式给出 2 1 12 1 1 功能模块和程序关系表功能模块和程序关系表 功能编 号 功能名称程序名称程序功能简述程序类型 备注 程序名称
5、 非面向对象语言写到函数级别 面向对象语言写到方法级别 即类名 方 法名 程序类型 指程序属于的处理类型 如 联机处理程序 批量处理程序 公用子程序 或者其它处理类型 2 1 22 1 2 复用说明复用说明 2 1 2 12 1 2 1 使用组件情况说明使用组件情况说明表表 组件指中心级管理的公共程序 此种公共程序不经修改即可以被使用 如果中心级组 件需要修改才能被使用 则在 2 1 2 2 的公共程序说明中体现 序号程序名称复用组件名称 标识使用目的 注 需要关注使用的组件情况跟程序的要求是否匹配 2 1 2 22 1 2 2 公共程序说明公共程序说明表表 公共程序指可以被两个以上程序调用的
6、程序 请在下表中进行说明 序号程序名称主要功能 2 22 2 程序详细设计程序详细设计 程序详细设计的任务是根据上述模块和程序关系表 以及公共程序说明 对每个 程序进行详细设计 即在 功能模块和程序关系表 和 公共程序说明表 中体现的所有 程序都需要 根据程序详细设计结果 程序员可以直接进行编码 程序详细设计结果以下表的形式给出 每个程序一张表 按模块排序 公共程序 模块 程序详细设计说明表程序详细设计说明表 日期 年 月 日 程序名称设计者 程序类型编程语言 功能描述 被调用方式 调用本程序列表 被调用程序列表 数据表 READADDDELETEUPDATE 访问数据表 参数意义数据类型格式
7、说明程序输入 数据 参数意义数据类型格式说明程序输出 数据 程序逻辑描述 推荐使用程序伪码的形式描述程序逻辑 也可以使用流程图等描述方法 利用一种结合一般文字敘述 非正确的程序语言来描述程序逻辑的程序码 称为伪 码 pseudo code 例如下面是一个排序程序的伪码 排序的元素放在阵列a中 for i 1 i 阵列大小 1 i依序加 1 for j i 1 j a j 交换 a i 及 a j 完成排序动作 利用伪码可弥补程序语言叙述的不足 而又有程序语言结构化且严谨的敘述能力 利 于书写和维护 缺点是不够直观 备注 说明 程序名称 非面向对象语言写到函数级别 面向对象语言写到方法级别 即
8、类名 方法名 被调用方式 LINK 引用 CALL COPY 其它 请说明 访问数据表 给出本程序需要访问的所有数据表 并标明访问方式 READ DELETE ADD UPDATE 如果操作处于判断分支中 则标明所有可能出 现的访问方式 备注 说明本程序是新程序还是在以前基础上做的修改 修改的相关情况等 第三章第三章 其它方面的设计考虑其它方面的设计考虑 3 13 1 系统出错信息系统出错信息 给出具体错误代码 错误信息内容等 如果在程序设计部分已经给出错误代码等内容 这里可以不填 错误信息总列表 错误代码错误信息备注 3 23 2 数据常量和变量设计数据常量和变量设计 给出系统 子系统内全局
9、性数据 常量 变量等 的数据结构 填写下表 程序内的局部 性数据不必列出 对于本节说明的常量 变量 要给出文字说明 说明其存储和其它方面的设计要求 然后给出列表 全局常量一览表全局常量一览表 制表人 制表日期 年 月 日 编号常量名用途类型系统 子系统名称 标识说明 如果是系统的全局常量 则系统名称不填 否则填写所属的子系统的名称或标识 若 填标识 则在第一章中应给出完整的定义 全部常量应按照系统全局常量 子系统全局性 常量的顺序填写 全局变量一览表全局变量一览表 制表人 制表日期 年 月 日 编号变量名用途类型取值范围系统 子系统 名称 标识 说明 如果是系统的全局变量 则系统名称不填 否则
10、填写所属的子系统的名称或标识 若 填标识 则在第一章中应给出完整的定义 全部变量应按照系统全局变量 子系统全局性 变量的顺序填写 3 33 3 配置文件配置文件 可选内容 交易代码交易代码配置文件描述配置文件描述配置文件名称配置文件名称配置项配置项备注备注 3 43 4 其它方面设计说明其它方面设计说明 在这一部分中 主要说明前述部分之外的设计内容 例如使用软件工具的主要配置 信息等 附录附录 A 详细修改说明 详细修改说明 修改日期 修改日期 2010 11 012010 11 01 序号序号修改内容修改内容 1 调整概述部分 只留待开发软件系统的名称 其余删掉 2 第二章增加复用说明 包括使用组件情况说明和符合软件复用标准的程序说明 3 第三章增加错误信息总列表 填写说明 对应前面的每次修订记录 除首次建立外 填写一张该表 根据本文档修改情况 总结修改内容点 填写表中 所有修改内容都以文字形式描述 要 求覆盖所有修改内容 所有修改点应当从工作任务的角度给出描述 有些工作任务可能在 正文中没有反映出来 但也要给出有关章节 不允许文档中有修改而本表中没有反映的情 况 对于本次修改内容 以蓝色表示 以后再调整时 需要首先把以前的蓝色调整为黑色 为了便于管理 对应于较长时间以前的且之后又修改多次的详细修改说明表 视情况可以 删除
