详细设计说明书模板.doc

产品详细设计说明书产品详细设计说明书 主要内容 第第 1 章章引言引言 1 1 1文档用途 1 1 2阅读对象 1 1 3名词术语 1 1 4参考资料 1 第第 2 章章概述概述 2 2 1系统概述 2 2 2系统功能定义 2 2 3设计约束 2 第第 3 章章总体结构说明总体结构说明 3 3 1子系统结构 3 3 2模块程序构件结构图 4 第第 4 章章数据模型 数据模型 DATA MODEL 设计 设计 6 4 1逻辑实体模型 6 4 2表结构 物理设计 7 4 3视图列表 9 第第 5 章章功能实现说明功能实现说明 10 5 1业务处理类模块 10 5 2数据流类模块 14 第第 6 章章界面实现说明界面实现说明 18 6 1模块 1 18 6 2模块 2 18 0 第第 1 章章 引言引言 1 1 文档用途文档用途 内容 说明此文档的主要用途 裁剪原则 此部分内容不允许裁剪 1 2 阅读对象阅读对象 内容 此文档将适合哪些人员阅读 如 产品设计工程师 产品开发工程师 产品测试工程师 其他相关人员 裁剪原则 此部分内容不允许裁剪 1 3 名词术语名词术语 内容 在该份文档中 为使阅读者对使用到的名词术语有一个概念性的理解 需要对一些名词进 行解释 裁剪原则 如果没有特别生疏的术语 此部分内容允许裁剪掉 1 4 参考资料参考资料 内容 列出该文档编写时的主要参考资料 主要包括 规范 客户需求规格说明书 老产品设 计文档 其他子系统的设计文档等 裁剪原则 如果没有参考其他资料 此部分内容允许裁剪掉 1 第第 2 章章 概述概述 2 1 系统概述系统概述 内容 说明此子系统 是什么 裁剪原则 此部分内容不允许裁剪 2 2 系统功能定义系统功能定义 内容 说明此子系统实现的主要功能 可逐条说明 裁剪原则 此部分内容不允许裁剪 2 3 设计约束设计约束 内容 从 产品需求规格说明书 中提取需求约束 例如 系统应当遵循的标准或规范 客户实际的软件 硬件环境条件的约束 接口 协议的约束 软件质量的约束 稳定性 可靠性 性能等 裁剪原则 此部分内容不允许裁剪 2 第第 3 章章 总体结构说明总体结构说明 3 1 子系统子系统结构结构 3 1 1系统内外部关系图系统内外部关系图 内容 采用如下图所示的模式表述下面两层关系 内部功能模块构成 与外部模块的接口关系 裁剪原则 此部分内容不允许裁剪 注 此图为举例 帐务管理模块 缴费管理 销帐管理 欠费管理 科目管理 帐单管理 帐务处理 帐单 调帐记录 减免记录 催缴系统 催缴工单 统一客户资料 二次批价 实时累加 周期费分摊 实时出帐 批量出帐 信用度管理 黑名单 红名单 白名单 客户管理 帐户管理 用户管理 实时费用查询三户基本信息 黑名单查询 红名单查询 清除黑名单 信用度查询 信用度更新 联机指令 半停工单 全停工单 拆线工单 系统管理 系统监控 权限管理权限信息 系统参数 监控信息 综合营业 帐务管理数据 获取最后销帐月 获取三户状态 更新状态 销户 更新销帐月 资金审核 帐务统计 客户服务 帐单 充值信息 外包服务商 银行 邮政 帐单 代缴数据 对帐数据 托单 代扣数据 回单 代收数据 活卡预存 现金缴费数据 轧帐 帐务管理总体视图 业务销帐顺序 帐本余额 未销帐帐单额 查询销帐信息 插入黑名单 科目信息 结转营业费用 3 3 1 2功能模块简要说明功能模块简要说明 内容 对诸功能模块完成的功能做简要说明 裁剪原则 此部分内容不允许裁剪 3 1 3依赖的外部接口依赖的外部接口 内容 说明各模块依赖的外部接口是什么 输入参数 输出参数 返回值等 裁剪原则 此部分内容不允许裁剪 3 1 4对外提供的接口对外提供的接口 内容 说明各模块对外提供的外部接口是什么 输入参数 输出参数 返回值等 裁剪原则 此部分内容不允许裁剪 3 2 模块程序构件结构图模块程序构件结构图 内容 详细描述程序构件结构图 并做文字说明 一般是有如下两种情况需做此描述 非中间件服务结构的后台处理进程模块 一般是异步操作等 在前台交互式操作的模块中 引入了非中间件服务结构的部件 裁剪原则 若不存在上述情况 此部分内容允许裁剪掉 注 此图为举例 4 Brower 网站门户 WWW Server Sun IS Agent OpenBroker 1 登录网站后访问 eCustomer Sun Identity Server2 认证 Sun LDAP Server 网站认证中心 3 认证 Random Session 4 认证 LDAP 后台标准Server Security Adapter 5 认证通过 6 查询 User ID t 7 查询 LDAP Database 8 连接数据库 5 第第 4 章章 数据模型 数据模型 Data Model 设计 设计 4 1 逻辑实体模型逻辑实体模型 说明 该部分的设计和开发 对于数据库环境 数据库表 字段命名规则等 应遵循 数据库设 计规范 进行 对规范有例外应用的情况 需在此说明 4 1 1实体模型实体模型 1 内容 描述本子系统核心的实体关系模型 如下图所示 要求做到 描述每一个实体的作用 指定实体标识 ID 对每一个 relationship 都要有说明 同时严格注意 Mandatory 是否必须 Cardinality 几对几关系 ER 图中的每个表中应有表名 主键字段名 重要字段名等信息 重要字段虽然不是 ER 图本身必须的 但可以更利于理解表的属性和关系 裁剪原则 此部分内容不允许裁剪 注 此图为举例 6 一 一 一 一 Manager of report to 一 一 一 一 parent of child of 一 一 一 一 composed of defined with 一 一 一 一 一 一 一 composed of member of 一 一 一 一 一 一 一 一 Organization Unit Org Id Parent Org id VA15 VA15 Position Postn id Parent Postn id VA15 VA15 Employee Agent Emp idVA15 User Login LoginNameVA15 Resposibility Respos idN9 Employee Competency Competency IdVA15 4 1 2实体模型实体模型 2 内容 如果有多个实体模型 需要按照上述的方式 诸一说明 4 2 表结构 物理设计 表结构 物理设计 内容 此部分主要设计表结构 一般地 实体对应于表 实体的属性对应于表的列 实体之间的 关系成为表的约束 逻辑设计中的实体大部分可以转换成为物理设计中的表 但是他们并 不一定是一一对应的 裁剪原则 此部分内容不允许裁剪 可以单独提供一份该子系统的表结构设计说明文档 按照如下内 容组织 7 4 2 1表汇总表汇总 序 号 子系统表名中文名称和简单描述 使用 方式 1 OB CM CUSTOME R 客户信息表公用 2 OBS CS 3 4 5 6 注 使用方式分为 公用 所有子系统均可访问 自用 仅本子系统可访问 临时 4 2 2OB CM CUSTOMER 表名 客户基本信息 中文名 所属子系统 日期 建表人 字段名称中文说明字段属性字段长度空值标志备注 索引 说明 表的字段的来源包括 ER图中的关系 参考逻辑实体模型 Object Model设计 参考Object Model设计 建议在简单描述前书写 这样整体表格可以被拷贝用作创建表的脚本 包括注释 使用Power Designer等自动设计工具的用户 可使用抓图等功能将表结构粘贴于此 说明 外部引用 指引用其他表的数据 但为设为主键的字段 主键 外键 外部引用 索引 触发器等的来源包括 ER图中的关系 参考逻辑实体模型 Object Model设计 参考Object Model设计 约束来源包括 字段描述 8 4 3 视图列表视图列表 序 号 子系统视图名相关表 使用 方式 描述 1OBS CSV Order OB CM CUSTOMER OB CM ODER 自用 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 注 使用方式分为 公用 其他子系统可访问 自用 仅本子系统可访问 临时 9 第第 5 章章 功能实现说明功能实现说明 说明 本章对每个功能模块中的每一个功能点做实现说明 有两类主要的应用 以数据流为核心的 处理流程是重点 以业务操作 为核心的 后台业务模型 前台展现模型是重点 强调用对象模型设计 下面用不同的章节分别给出这两类应用的设计文 档模板 5 1 业务处理类模块业务处理类模块 说明 该类模块的特点是 需要提供对象接口 Object Interface 对象模型是重点 5 1 1Object 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 实现说明实现说明 内容 如果有多个功能点 需要按照上述的方式 逐一说明 10 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 数据检查数据检查 字段字段中文名称中文名称数据长度数据长度 数据类型数据类型 缺省值缺省值检查逻辑检查逻辑 Icurcd币别3X012必须输入 itxamt交易金额10 2N输入值大于 1 00 小于 99999999 99 5 1 2 1 5 CLIENT SERVER 数据界面数据界面 字段字段名称名称长度长度取值取值 TITA BASIC LABEL HTRMSEQ取消终端机号2 11 HEJFNO取消日志序号6取消时原始交易流水号 OPNBR开户行5本行行号 KINBR交易行5本行行号 TRMSEQ终端机号2 EJFNO日志序号6 TASKID程序类别2UT TMTYPE终端类型10 APTYPE交易类型1T TXNO交易代码42429 PTYPE处理形态10 DSCPT科目摘要3输入值 HCODE取消标志1取消时为 1 ACTNO帐号15 SEQNO帐户序号 TXTYPE帐务类别200 MULTTX连动标志1系统变数 CRDB借贷标志12 SUPINIT1主管标志 12系统变数 SUPINIT2主管标志 22系统变数 REASON主管许可理由6000 TLRNO操作员号2系统变数 CASHIER出纳号码 NBCD无折交易标志10 TRNMOD训练模式标志1 SBTMOD代登模式标志1 CURCD币别3012 XCRT汇率8 VOCNO存单号7 0000000 TXAMT交易金额12 SUPCODE主管代码6 SUPPASSW D 主管密码6 TITA TEXT custid商户编号5 custmno商户手工押单机号6 cutlrcd商户操作员号6 cardno卡号16 idtype证件种类1 idno证件号码20 Icurcd币别3 itxamt交易金额10 2 5 1 2 1 6 处理流程处理流程 初始化程序变量 ict2429 Initial 初始化表结构 CDTABHTR 手工押单表 初始化开关 卡流水 帐务流水 总帐 柜员帐 ict2429 Verify 检查流水号 卡号 金额 商户号 终端号 授权日期 营业网点 操作员 授权操作员 授权号 取消交易检查 本笔交易日必须为当前系统交易日 ict2429 Process 12 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 goldt ype diffplac txtype 准备输出数据 ict2429 PutMsg 输出 TOTA 开户信息 流水号 卡号 商户号 终端号 币别 金额 5 1 2 1 7 SERVER CLIENT 数据界面数据界面 TOTA TEXT 字段字段中文名称中文名称长度长度说明说明 F2429 Name持卡人姓名30 idtypew申请人证件种类的文字形式6 gtlsrno帐务交易流水号6 Gtlrcd授权柜员号6 txdate授权日期8 kinbr授权机构码5 autnum授权号 8 5 1 2 1 8 输出要素输出要素 显示 卡号 金额 商户号 终端号 申权日期 申权时间 营业网点号 营业人员号 授权码 13 5 1 2 1 9 本交易所涉及到的库表本交易所涉及到的库表 贷记卡管理档 卡登记簿 cdm 贷款分户文件 cccmr 备用金分户文件 ccsmr 5 2 数据流类模块数据流类模块 说明 该类模块的特点是 接口通常是数据文件或XML的形式 接口文件内容比较稳定 5 2 1数据流程图数据流程图 内容 用数据流图 Data Flow Diagram DFD 描述该功能模块总的数据流图 并给出文字说明 例如缴费管理模块总体数据流图 裁剪原则 此部分内容不允许裁剪 注 此图为举例 支票缴费 缴费流水 销帐通知 缴费前 处理 帐户帐单表 帐户帐单 明细表 前台显示 帐单数据 待审核资金表 缴费处理 坏帐缴费 资金转移 业务退费 统一客户资料 查询帐户接口 实时费用查询 滞纳金计算 接口 缴费代码类型 交费代码 缴费撤单 销帐管理反销 帐 冲正接口 银行对帐 银行对帐文件 银行对帐记录 表 银行对帐记录 明细表 缴费管理数据流程图 帐单管理费用 减免 滞纳金 减免接口 帐户帐本表 帐户帐本变动 明细表 14 5 2 2实现说明实现说明 5 2 2 1功能点功能点 1 实现说明实现说明 内容 功能点实现说明包括以下一些内容 功能定义 处理流程 业务规则 什么条件下能做什么事情 什么条件下不能做什么事情 其他说明 对 处理流程 有两种图示方式 1 流程图方式 Flow Chart 2 UML Sequence Diagram 方式 下图是一个缴费退费处理流程图方式示例 裁剪原则 此部分内容不允许裁剪 注 此图为举例 否 缴费时的流水号 帐户 号 获取相应的 缴费记录 销帐管理反销帐 接口 欠费管理欠费判 断处理接口 缴费退费处理 支票缴费 是 作废 资金待审核记录 已审核否 退还支票 否 退现金 是 开始 结束 15 5 2 2 2功能点功能点 2 实现说明实现说明 内容 如果有多个功能