详细设计说明书模板

产品详细设计说明书

主要内容

第1章 1.1 1.2 1.3 1.4 第2章 2.1 2.2 2.3 第3章 3.1 3.2 第4章 4.1 4.2 4.3 第5章 5.1 5.2 第6章 6.1 6.2

引言 ............................................................................................................................ 1 文档用途 ........................................................................................................................ 1 阅读对象 ........................................................................................................................ 1 名词术语 ........................................................................................................................ 1 参考资料 ........................................................................................................................ 1 概述 ............................................................................................................................ 2 系统概述 ........................................................................................................................ 2 系统功能定义 ................................................................................................................. 2 设计约束 ........................................................................................................................ 2 总体结构说明 .............................................................................................................. 3 子系统结构 ..................................................................................................................... 3 模块程序构件结构图 ....................................................................................................... 4 数据模型（DATA MODEL）设计 ............................................................................... 6 逻辑实体模型 ................................................................................................................. 6 表结构（物理设计） ....................................................................................................... 7 视图列表 ........................................................................................................................ 9 功能实现说明 ............................................................................................................ 10 业务处理类模块 ............................................................................................................ 10 数据流类模块 ............................................................................................................... 14 界面实现说明 ............................................................................................................ 18 模块1........................................................................................................................... 18 模块2........................................................................................................................... 18

第1章 引言

1.1 文档用途

【内容】

说明此文档的主要用途。

【裁剪原则】

此部分内容不允许裁剪。

1.2 阅读对象

【内容】

此文档将适合哪些人员阅读。如：  产品设计工程师  产品开发工程师  产品测试工程师  其他相关人员

【裁剪原则】

此部分内容不允许裁剪。

1.3 名词术语

【内容】

在该份文档中，为使阅读者对使用到的名词术语有一个概念性的理解，需要对一些名词进行解释。

【裁剪原则】

如果没有特别生疏的术语，此部分内容允许裁剪掉。

1.4 参考资料

【内容】

列出该文档编写时的主要参考资料。主要包括：规范、《客户需求规格说明书》、老产品设计文档、其他子系统的设计文档等。

【裁剪原则】

如果没有参考其他资料，此部分内容允许裁剪掉。

第2章 概述

2.1 系统概述

【内容】

说明此子系统“是什么”。

【裁剪原则】

此部分内容不允许裁剪。

2.2 系统功能定义

【内容】

说明此子系统实现的主要功能，可逐条说明。

【裁剪原则】

此部分内容不允许裁剪。

2.3 设计约束

【内容】

从《产品需求规格说明书》中提取需求约束。例如：  系统应当遵循的标准或规范

 客户实际的软件、硬件环境条件的约束  接口/协议的约束



软件质量的约束：稳定性、可靠性、性能等。

【裁剪原则】

此部分内容不允许裁剪。

第3章 总体结构说明

3.1 子系统结构

3.1.1 系统内外部关系图

【内容】

采用如下图所示的模式表述下面两层关系： 

内部功能模块构成



与外部模块的接口关系

【裁剪原则】

此部分内容不允许裁剪。 注：此图为举例：

帐务管理总体视图

3.1.2 功能模块简要说明

【内容】

对诸功能模块完成的功能做简要说明。

【裁剪原则】

此部分内容不允许裁剪。

3.1.3 依赖的外部接口

【内容】

说明各模块依赖的外部接口是什么，输入参数、输出参数、返回值等。

【裁剪原则】

此部分内容不允许裁剪。

3.1.4 对外提供的接口

【内容】

说明各模块对外提供的外部接口是什么，输入参数、输出参数、返回值等。

【裁剪原则】

此部分内容不允许裁剪。

3.2 模块程序构件结构图

【内容】

详细描述程序构件结构图，并做文字说明。一般是有如下两种情况需做此描述： 非中间件服务结构的后台处理进程模块（一般是异步操作等） 

在前台交互式操作的模块中，引入了非中间件服务结构的部件；

【裁剪原则】

若不存在上述情况，此部分内容允许裁剪掉。 注：此图为举例：

第4章 数据模型（Data Model）设计

4.1 逻辑实体模型

【说明】

该部分的设计和开发，对于数据库环境、数据库表、字段命名规则等，应遵循《数据库设计规范》进行。对规范有例外应用的情况，需在此说明。

4.1.1 实体模型1

【内容】

描述本子系统核心的实体关系模型。如下图所示。要求做到：   

描述每一个实体的作用，指定实体标识（ID）

对每一个relationship都要有说明，同时严格注意Mandatory(是否必须)，Cardinality(几对几关系)

ER图中的每个表中应有表名、主键字段名、重要字段名等信息。重要字段虽然不是ER

图本身必须的，但可以更利于理解表的属性和关系。

【裁剪原则】

此部分内容不允许裁剪。 注：此图为举例：

4.1.2 实体模型2

【内容】

如果有多个实体模型，需要按照上述的方式，诸一说明。

4.2 表结构（物理设计）

【内容】

此部分主要设计表结构。一般地，实体对应于表，实体的属性对应于表的列，实体之间的关系成为表的约束。逻辑设计中的实体大部分可以转换成为物理设计中的表，但是他们并不一定是一一对应的。

【裁剪原则】

此部分内容不允许裁剪。可以单独提供一份该子系统的表结构设计说明文档。按照如下内容组织。

4.2.1 表汇总

4.2.2 OB_CM_CUSTOMER

表名 客户基本信息 中文名 所属子系统 日期 建表人 表的字段的来源包括：

 ER；

 Object Model设计（参考Object Model设计）； 建议在简单描述前书写 “- -”，这样整体表格可以被拷贝用作创建表的脚本，包括注释。 使用Power Designer等自动设计工具的用户，可使用抓图等功能将表结构粘贴于此。 【说明】 “外部引用”指引用其他表的数据,但为设为主键的字段。

主键、外键、外部引用、索引、触发器等的来源包括：  ER；

 Object Model设计（参考Object Model； 约束来源包括：  字段描述。

4.3 视图列表

第5章 功能实现说明

【说明】

本章对每个功能模块中的每一个功能点做实现说明。有两类主要的应用：以数据流为核心的，处理流程是重点；以业务操作为核心的，后台业务模型、前台展现模型是重点（强调用对象模型设计）。下面用不同的章节分别给出这两类应用的设计文档模板。

5.1 业务处理类模块

【说明】 该类模块的特点是：需要提供对象接口（Object Interface），对象模型是重点。

5.1.1 Object Model设计

5.1.1.1 功能点1实现说明

5.1.1.1.1 Sequence Diagram

【内容】

所需功能的序列图。如果包含多个业务操作，应绘制多幅序列图，原则是：  尽量覆盖到对象参与此功能的所有方法；

 如果某个业务操作非常简单（例如两个对象、三次调用），可以用文字简单描述；5.1.1.1.2 实现说明

【内容】

功能点实现说明包括以下一些内容：

 主要实现方法说明



操作了哪些数据库表的哪些字段

如：Object1.GetData(): DB_customer.name, ID, DB_ADSL.*.

【裁剪原则】

此部分内容不允许裁剪。

5.1.1.2 功能点2实现说明

【内容】

如果有多个功能点，需要按照上述的方式，逐一说明。

5.1.2 程序设计

5.1.2.1 交易功能1名称

5.1.2.1.1 功能说明

处理贷记卡存款及取消

5.1.2.1.2 交易限制 使用者：不限

能否可以做反交易：可以

5.1.2.1.3 输入要素

贷记卡特约商户手工押单录入 2429 流水号 卡号 商户号 终端号

授权码

营业网点号（手工单录入时的网点号） 录入操作员（手工单录入时的操作员） 币别 金额

5.1.2.1.4 数据检查

5.1.2.1.5 CLIENTSERVER数据界面

5.1.2.1.6 处理流程

 初始化程序变量-ict2429_Initial() 初始化表结构：CDTABHTR（手工押单表） 初始化开关：卡流水、帐务流水、总帐、柜员帐  ict2429_Verify()

检查流水号、卡号、金额、商户号、终端号、授权日期、营业网点、操作员、授权操作员、授权号 取消交易检查：本笔交易日必须为当前系统交易日。  ict2429_Process()

1. 更新手工押单文件 CDTABHTR 

帐务处理（分录）：

取款金额（A）＝X，备用金户可用余额＝Y，T＝X－Y 发生贷款时的分录 借：中间科目 贷：特约商户

 准备交易日志文件记录

记帐务流水：actno、addr、name、curcd、avbal、text_len

记卡流水：cardno、actno、accnum、listnu、cdseq、txamt、dscpt、txtype、tmtype、fee、ctlflag、tmtype、goldtype、diffplac、txtype

 准备输出数据-ict2429_PutMsg() 输出TOTA开户信息 流水号 卡号 商户号 终端号 币别 金额

5.1.2.1.7 SERVERCLIENT数据界面

5.1.2.1.8 输出要素

 显示 卡号 金额 商户号 终端号 申权日期 申权时间 营业网点号 营业人员号 授权码

5.1.2.1.9 本交易所涉及到的库表

  

贷记卡管理档（卡登记簿）cdm 贷款分户文件cccmr 备用金分户文件ccsmr

5.2 数据流类模块

【说明】

该类模块的特点是：接口通常是数据文件或XML的形式，接口文件内容比较稳定。

5.2.1 数据流程图

【内容】

用数据流图（Data Flow Diagram-DFD）描述该功能模块总的数据流图。并给出文字说明。例如缴费管理模块总体数据流图：

【裁剪原则】

此部分内容不允许裁剪。 注：此图为举例：

缴费管理数据流程图

5.2.2 实现说明

5.2.2.1 功能点1实现说明

【内容】

功能点实现说明包括以下一些内容：



  

对“处理流程”，有两种图示方式：1)流程图方式（Flow Chart）；2)UML Sequence Diagram 方式。下图是一个缴费退费处理流程图方式示例。

功能定义 处理流程

业务规则（什么条件下能做什么事情，什么条件下不能做什么事情） 其他说明

【裁剪原则】

此部分内容不允许裁剪。 注：此图为举例：

缴费退费处理

5.2.2.2 功能点2实现说明

【内容】

如果有多个功能点，需要按照上述的方式，诸一说明。

5.2.3 程序设计

5.2.3.1 类定义

【内容】

说明类的定义，包括属性、接口函数等。

【裁剪原则】

此部分内容不允许裁剪。

5.2.3.2 数据结构定义

【内容】

给出数据结构或数据元素（变量）的特性，包括名称、标识符、数据类型和格式、值的有效范围，并给出定义性描述，最好能用类C语言给出类型说明。

【裁剪原则】

此部分内容不允许裁剪。

5.2.3.3 目标文件定义

【内容】

说明该模块将提供哪些包（.So,.jar等）。

【裁剪原则】

此部分内容不允许裁剪。

5.2.3.4 接口定义

【内容】

重点描述接口文件格式、接口方式（批处理、逐条；本地、远程；远程提供传输方式等）。

【说明】

该部分内容参见《OpenBoss概要设计说明书－××子系统接口定义（模板）》。

【裁剪原则】

此部分内容不允许裁剪

第6章 界面实现说明

6.1 模块1

【说明】

界面的设计和开发需参考《用户界面设计规范》进行。

6.1.1 总体界面结构（业务操作区）说明

【内容】

可以用图示辅助说明，可以用网页、C++Builder Form等说明如下内容：

 有哪些界面  

界面的主要风格，构成元素 界面流转

【裁剪原则】

此部分内容不允许裁剪。

6.1.2 功能点1界面结构说明

【内容】

从本节开始，对一些关键的、重要的、关系复杂的功能点界面予以特殊说明。对那些单一

Form即可完成功能的就不用单独描述。定义清楚View/Form、View Flow、Drilldown等。

6.1.3 功能点2界面结构说明

【内容】

内容同上。

6.2 模块2

同模块1

产品详细设计说明书

主要内容

第1章 1.1 1.2 1.3 1.4 第2章 2.1 2.2 2.3 第3章 3.1 3.2 第4章 4.1 4.2 4.3 第5章 5.1 5.2 第6章 6.1 6.2

引言 ............................................................................................................................ 1 文档用途 ........................................................................................................................ 1 阅读对象 ........................................................................................................................ 1 名词术语 ........................................................................................................................ 1 参考资料 ........................................................................................................................ 1 概述 ............................................................................................................................ 2 系统概述 ........................................................................................................................ 2 系统功能定义 ................................................................................................................. 2 设计约束 ........................................................................................................................ 2 总体结构说明 .............................................................................................................. 3 子系统结构 ..................................................................................................................... 3 模块程序构件结构图 ....................................................................................................... 4 数据模型（DATA MODEL）设计 ............................................................................... 6 逻辑实体模型 ................................................................................................................. 6 表结构（物理设计） ....................................................................................................... 7 视图列表 ........................................................................................................................ 9 功能实现说明 ............................................................................................................ 10 业务处理类模块 ............................................................................................................ 10 数据流类模块 ............................................................................................................... 14 界面实现说明 ............................................................................................................ 18 模块1........................................................................................................................... 18 模块2........................................................................................................................... 18

第1章 引言

1.1 文档用途

【内容】

说明此文档的主要用途。

【裁剪原则】

此部分内容不允许裁剪。

1.2 阅读对象

【内容】

此文档将适合哪些人员阅读。如：  产品设计工程师  产品开发工程师  产品测试工程师  其他相关人员

【裁剪原则】

此部分内容不允许裁剪。

1.3 名词术语

【内容】

在该份文档中，为使阅读者对使用到的名词术语有一个概念性的理解，需要对一些名词进行解释。

【裁剪原则】

如果没有特别生疏的术语，此部分内容允许裁剪掉。

1.4 参考资料

【内容】

列出该文档编写时的主要参考资料。主要包括：规范、《客户需求规格说明书》、老产品设计文档、其他子系统的设计文档等。

【裁剪原则】

如果没有参考其他资料，此部分内容允许裁剪掉。

第2章 概述

2.1 系统概述

【内容】

说明此子系统“是什么”。

【裁剪原则】

此部分内容不允许裁剪。

2.2 系统功能定义

【内容】

说明此子系统实现的主要功能，可逐条说明。

【裁剪原则】

此部分内容不允许裁剪。

2.3 设计约束

【内容】

从《产品需求规格说明书》中提取需求约束。例如：  系统应当遵循的标准或规范

 客户实际的软件、硬件环境条件的约束  接口/协议的约束



软件质量的约束：稳定性、可靠性、性能等。

【裁剪原则】

此部分内容不允许裁剪。

第3章 总体结构说明

3.1 子系统结构

3.1.1 系统内外部关系图

【内容】

采用如下图所示的模式表述下面两层关系： 

内部功能模块构成



与外部模块的接口关系

【裁剪原则】

此部分内容不允许裁剪。 注：此图为举例：

帐务管理总体视图

3.1.2 功能模块简要说明

【内容】

对诸功能模块完成的功能做简要说明。

【裁剪原则】

此部分内容不允许裁剪。

3.1.3 依赖的外部接口

【内容】

说明各模块依赖的外部接口是什么，输入参数、输出参数、返回值等。

【裁剪原则】

此部分内容不允许裁剪。

3.1.4 对外提供的接口

【内容】

说明各模块对外提供的外部接口是什么，输入参数、输出参数、返回值等。

【裁剪原则】

此部分内容不允许裁剪。

3.2 模块程序构件结构图

【内容】

详细描述程序构件结构图，并做文字说明。一般是有如下两种情况需做此描述： 非中间件服务结构的后台处理进程模块（一般是异步操作等） 

在前台交互式操作的模块中，引入了非中间件服务结构的部件；

【裁剪原则】

若不存在上述情况，此部分内容允许裁剪掉。 注：此图为举例：

第4章 数据模型（Data Model）设计

4.1 逻辑实体模型

【说明】

该部分的设计和开发，对于数据库环境、数据库表、字段命名规则等，应遵循《数据库设计规范》进行。对规范有例外应用的情况，需在此说明。

4.1.1 实体模型1

【内容】

描述本子系统核心的实体关系模型。如下图所示。要求做到：   

描述每一个实体的作用，指定实体标识（ID）

对每一个relationship都要有说明，同时严格注意Mandatory(是否必须)，Cardinality(几对几关系)

ER图中的每个表中应有表名、主键字段名、重要字段名等信息。重要字段虽然不是ER

图本身必须的，但可以更利于理解表的属性和关系。

【裁剪原则】

此部分内容不允许裁剪。 注：此图为举例：

4.1.2 实体模型2

【内容】

如果有多个实体模型，需要按照上述的方式，诸一说明。

4.2 表结构（物理设计）

【内容】

此部分主要设计表结构。一般地，实体对应于表，实体的属性对应于表的列，实体之间的关系成为表的约束。逻辑设计中的实体大部分可以转换成为物理设计中的表，但是他们并不一定是一一对应的。

【裁剪原则】

此部分内容不允许裁剪。可以单独提供一份该子系统的表结构设计说明文档。按照如下内容组织。

4.2.1 表汇总

4.2.2 OB_CM_CUSTOMER

表名 客户基本信息 中文名 所属子系统 日期 建表人 表的字段的来源包括：

 ER；

 Object Model设计（参考Object Model设计）； 建议在简单描述前书写 “- -”，这样整体表格可以被拷贝用作创建表的脚本，包括注释。 使用Power Designer等自动设计工具的用户，可使用抓图等功能将表结构粘贴于此。 【说明】 “外部引用”指引用其他表的数据,但为设为主键的字段。

主键、外键、外部引用、索引、触发器等的来源包括：  ER；

 Object Model设计（参考Object Model； 约束来源包括：  字段描述。

4.3 视图列表

第5章 功能实现说明

【说明】

本章对每个功能模块中的每一个功能点做实现说明。有两类主要的应用：以数据流为核心的，处理流程是重点；以业务操作为核心的，后台业务模型、前台展现模型是重点（强调用对象模型设计）。下面用不同的章节分别给出这两类应用的设计文档模板。

5.1 业务处理类模块

【说明】 该类模块的特点是：需要提供对象接口（Object Interface），对象模型是重点。

5.1.1 Object Model设计

5.1.1.1 功能点1实现说明

5.1.1.1.1 Sequence Diagram

【内容】

所需功能的序列图。如果包含多个业务操作，应绘制多幅序列图，原则是：  尽量覆盖到对象参与此功能的所有方法；

 如果某个业务操作非常简单（例如两个对象、三次调用），可以用文字简单描述；5.1.1.1.2 实现说明

【内容】

功能点实现说明包括以下一些内容：

 主要实现方法说明



操作了哪些数据库表的哪些字段

如：Object1.GetData(): DB_customer.name, ID, DB_ADSL.*.

【裁剪原则】

此部分内容不允许裁剪。

5.1.1.2 功能点2实现说明

【内容】

如果有多个功能点，需要按照上述的方式，逐一说明。

5.1.2 程序设计

5.1.2.1 交易功能1名称

5.1.2.1.1 功能说明

处理贷记卡存款及取消

5.1.2.1.2 交易限制 使用者：不限

能否可以做反交易：可以

5.1.2.1.3 输入要素

贷记卡特约商户手工押单录入 2429 流水号 卡号 商户号 终端号

授权码

营业网点号（手工单录入时的网点号） 录入操作员（手工单录入时的操作员） 币别 金额

5.1.2.1.4 数据检查

5.1.2.1.5 CLIENTSERVER数据界面

5.1.2.1.6 处理流程

 初始化程序变量-ict2429_Initial() 初始化表结构：CDTABHTR（手工押单表） 初始化开关：卡流水、帐务流水、总帐、柜员帐  ict2429_Verify()

检查流水号、卡号、金额、商户号、终端号、授权日期、营业网点、操作员、授权操作员、授权号 取消交易检查：本笔交易日必须为当前系统交易日。  ict2429_Process()

1. 更新手工押单文件 CDTABHTR 

帐务处理（分录）：

取款金额（A）＝X，备用金户可用余额＝Y，T＝X－Y 发生贷款时的分录 借：中间科目 贷：特约商户

 准备交易日志文件记录

记帐务流水：actno、addr、name、curcd、avbal、text_len

记卡流水：cardno、actno、accnum、listnu、cdseq、txamt、dscpt、txtype、tmtype、fee、ctlflag、tmtype、goldtype、diffplac、txtype

 准备输出数据-ict2429_PutMsg() 输出TOTA开户信息 流水号 卡号 商户号 终端号 币别 金额

5.1.2.1.7 SERVERCLIENT数据界面

5.1.2.1.8 输出要素

 显示 卡号 金额 商户号 终端号 申权日期 申权时间 营业网点号 营业人员号 授权码

5.1.2.1.9 本交易所涉及到的库表

  

贷记卡管理档（卡登记簿）cdm 贷款分户文件cccmr 备用金分户文件ccsmr

5.2 数据流类模块

【说明】

该类模块的特点是：接口通常是数据文件或XML的形式，接口文件内容比较稳定。

5.2.1 数据流程图

【内容】

用数据流图（Data Flow Diagram-DFD）描述该功能模块总的数据流图。并给出文字说明。例如缴费管理模块总体数据流图：

【裁剪原则】

此部分内容不允许裁剪。 注：此图为举例：

缴费管理数据流程图

5.2.2 实现说明

5.2.2.1 功能点1实现说明

【内容】

功能点实现说明包括以下一些内容：



  

对“处理流程”，有两种图示方式：1)流程图方式（Flow Chart）；2)UML Sequence Diagram 方式。下图是一个缴费退费处理流程图方式示例。

功能定义 处理流程

业务规则（什么条件下能做什么事情，什么条件下不能做什么事情） 其他说明

【裁剪原则】

此部分内容不允许裁剪。 注：此图为举例：

缴费退费处理

5.2.2.2 功能点2实现说明

【内容】

如果有多个功能点，需要按照上述的方式，诸一说明。

5.2.3 程序设计

5.2.3.1 类定义

【内容】

说明类的定义，包括属性、接口函数等。

【裁剪原则】

此部分内容不允许裁剪。

5.2.3.2 数据结构定义

【内容】

给出数据结构或数据元素（变量）的特性，包括名称、标识符、数据类型和格式、值的有效范围，并给出定义性描述，最好能用类C语言给出类型说明。

【裁剪原则】

此部分内容不允许裁剪。

5.2.3.3 目标文件定义

【内容】

说明该模块将提供哪些包（.So,.jar等）。

【裁剪原则】

此部分内容不允许裁剪。

5.2.3.4 接口定义

【内容】

重点描述接口文件格式、接口方式（批处理、逐条；本地、远程；远程提供传输方式等）。

【说明】

该部分内容参见《OpenBoss概要设计说明书－××子系统接口定义（模板）》。

【裁剪原则】

此部分内容不允许裁剪

第6章 界面实现说明

6.1 模块1

【说明】

界面的设计和开发需参考《用户界面设计规范》进行。

6.1.1 总体界面结构（业务操作区）说明

【内容】

可以用图示辅助说明，可以用网页、C++Builder Form等说明如下内容：

 有哪些界面  

界面的主要风格，构成元素 界面流转

【裁剪原则】

此部分内容不允许裁剪。

6.1.2 功能点1界面结构说明

【内容】

从本节开始，对一些关键的、重要的、关系复杂的功能点界面予以特殊说明。对那些单一

Form即可完成功能的就不用单独描述。定义清楚View/Form、View Flow、Drilldown等。

6.1.3 功能点2界面结构说明

【内容】

内容同上。

6.2 模块2

同模块1