详细设计说明书模板.docx

1、详细设计说明书模板项目名称详细设计说明书文档编号：CRB_QA_DDD_TMP文档信息：详细设计说明书模板文档名称：文档类别：质量管理模板密 级：机密版本信息：1.0创 建 人：侯智勇审 核 者： 批 准 人： 批准日期：保 管 人：存放位置：编辑软件：Microsoft Office 2007 中文版CONFIDENTIAL文档修订记录版本编号或者更改记录编号*变化状态简要说明（变更内容和变更范围）日期变更人批准日期批准人V1.0A新增2010-12-7侯智勇*变化状态：A增加，M修改，D删除文档审批信息序号审批人角色审批日期签字备注目录第1章 引言 11.1 文档用途 11.2 阅读对象

2、11.3 名词术语 11.4 参考资料 1第2章 概述 22.1 系统概述 22.2 系统功能定义 22.3 设计约束 2第3章 总体结构说明 33.1 子系统结构 33.2 模块程序构件结构图 4第4章 数据模型（Data Model）设计 64.1 逻辑实体模型 64.2 表结构（物理设计） 74.3 视图列表 9第5章 功能实现说明 105.1 业务处理类模块 105.2 数据流类模块 14第6章 面实现说明 176.1 模块1 176.2 模块2 17 第1章 引言1.1 文档用途【内容】说明此文档的主要用途。【裁剪原则】此部分内容不允许裁剪。1.2 阅读对象【内容】此文档将适合哪些人

3、员阅读。如： 产品设计工程师 产品开发工程师 产品测试工程师 其他相关人员【裁剪原则】此部分内容不允许裁剪。1.3 名词术语【内容】在该份文档中，为使阅读者对使用到的名词术语有一个概念性的理解，需要对一些名词进行解释。【裁剪原则】如果没有特别生疏的术语，此部分内容允许裁剪掉。1.4 参考资料【内容】列出该文档编写时的主要参考资料。主要包括：规范、客户需求规格说明书、老产品设计文档、其他子系统的设计文档等。【裁剪原则】如果没有参考其他资料，此部分内容允许裁剪掉。第2章 概述2.1 系统概述【内容】说明此子系统“是什么”。【裁剪原则】此部分内容不允许裁剪。2.2 系统功能定义【内容】说明此子系统实

4、现的主要功能，可逐条说明。【裁剪原则】此部分内容不允许裁剪。2.3 设计约束【内容】从产品需求规格说明书中提取需求约束。例如： 系统应当遵循的标准或规范 客户实际的软件、硬件环境条件的约束 接口/协议的约束 软件质量的约束：稳定性、可靠性、性能等。【裁剪原则】此部分内容不允许裁剪。第3章 总体结构说明3.1 子系统结构3.1.1 系统内外部关系图【内容】 采用如下图所示的模式表述下面两层关系： 内部功能模块构成 与外部模块的接口关系【裁剪原则】此部分内容不允许裁剪。注：此图为举例：3.1.2 功能模块简要说明【内容】对诸功能模块完成的功能做简要说明。【裁剪原则】此部分内容不允许裁剪。3.1.3

5、 依赖的外部接口【内容】说明各模块依赖的外部接口是什么，输入参数、输出参数、返回值等。【裁剪原则】此部分内容不允许裁剪。3.1.4 对外提供的接口【内容】说明各模块对外提供的外部接口是什么，输入参数、输出参数、返回值等。【裁剪原则】此部分内容不允许裁剪。3.2 模块程序构件结构图【内容】详细描述程序构件结构图，并做文字说明。一般是有如下两种情况需做此描述： 非中间件服务结构的后台处理进程模块（一般是异步操作等） 在前台交互式操作的模块中，引入了非中间件服务结构的部件；【裁剪原则】若不存在上述情况，此部分内容允许裁剪掉。注：此图为举例：第4章 数据模型（Data Model）设计4.1 逻辑实体

6、模型【说明】该部分的设计和开发，对于数据库环境、数据库表、字段命名规则等，应遵循数据库设计规范进行。对规范有例外应用的情况，需在此说明。4.1.1 实体模型1【内容】描述本子系统核心的实体关系模型。如下图所示。要求做到： 描述每一个实体的作用，指定实体标识（ID） 对每一个relationship都要有说明，同时严格注意Mandatory(是否必须)，Cardinality(几对几关系) ER图中的每个表中应有表名、主键字段名、重要字段名等信息。重要字段虽然不是ER图本身必须的，但可以更利于理解表的属性和关系。【裁剪原则】此部分内容不允许裁剪。注：此图为举例：4.1.2 实体模型2【内容】如果

7、有多个实体模型，需要按照上述的方式，诸一说明。4.2 表结构（物理设计）【内容】此部分主要设计表结构。一般地，实体对应于表，实体的属性对应于表的列，实体之间的关系成为表的约束。逻辑设计中的实体大部分可以转换成为物理设计中的表，但是他们并不一定是一一对应的。【裁剪原则】此部分内容不允许裁剪。可以单独提供一份该子系统的表结构设计说明文档。按照如下内容组织。4.2.1 表汇总序号子系统表名中文名称和简单描述使用方式1OBS-CSOB_CM_CUSTOMER客户信息表公用23456注：使用方式分为：公用（所有子系统均可访问）、自用（仅本子系统可访问）、临时。4.2.2 OB_CM_CUSTOMER表名

8、 客户基本信息中文名所属子系统日期建表人字段名称中文说明字段属性字段长度空值标志备注索引【说明】表的字段的来源包括： ER图中的关系（参考逻辑实体模型）； Object Model设计（参考Object Model设计）；建议在简单描述前书写 “- -”，这样整体表格可以被拷贝用作创建表的脚本，包括注释。使用Power Designer等自动设计工具的用户，可使用抓图等功能将表结构粘贴于此。【说明】 “外部引用”指引用其他表的数据,但为设为主键的字段。主键、外键、外部引用、索引、触发器等的来源包括： ER图中的关系（参考逻辑实体模型）； Object Model设计（参考Object Mode

9、l设计）；约束来源包括： 字段描述。4.3 视图列表序号子系统视图名相关表使用方式描述1 OBS-CSV_OrderOB_CM_CUSTOMER,OB_CM_ODER自用2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 注：使用方式分为：公用（其他子系统可访问）、自用（仅本子系统可访问）、临时。第5章 功能实现说明【说明】本章对每个功能模块中的每一个功能点做实现说明。有两类主要的应用：以数据流为核心的，处理流程是重点；以业务操作为核心的，后台业务模型、前台展现模型是重点（强调用对象模型设计）。下面用不同的章节分别给出这两类应用的设计文档模板。5.1 业务处理类模块【说明

10、】 该类模块的特点是：需要提供对象接口（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

11、, 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 数据检查字段中文名称数据长度数据类型缺省值检查逻辑Icurcd币别3X012必须输入itxamt交易金额1

12、0.2N输入值大于1.00小于99999999.995.1.2.1.5 CLIENTSERVER数据界面字段名称长度取值TITA BASIC LABELHTRMSEQ取消终端机号2HEJFNO取消日志序号6取消时原始交易流水号OPNBR开户行5本行行号KINBR交易行5本行行号TRMSEQ终端机号2EJFNO日志序号6TASKID程序类别2UTTMTYPE终端类型10APTYPE交易类型1TTXNO交易代码42429PTYPE处理形态10DSCPT科目摘要3输入值HCODE取消标志1取消时为1ACTNO帐号15“ ”SEQNO帐户序号TXTYPE帐务类别200MULTTX连动标志1系统变数CR

13、DB借贷标志12SUPINIT1主管标志12系统变数SUPINIT2主管标志22系统变数REASON主管许可理由6000TLRNO操作员号2系统变数CASHIER出纳号码NBCD无折交易标志10TRNMOD训练模式标志1SBTMOD代登模式标志1CURCD币别3012XCRT汇率8VOCNO存单号7“0000000”TXAMT交易金额12SUPCODE主管代码6SUPPASSWD主管密码6TITA TEXTcustid商户编号5custmno商户手工押单机号6cutlrcd商户操作员号6cardno卡号16idtype证件种类1idno证件号码20Icurcd币别3itxamt交易金额10.2

14、5.1.2.1.6 处理流程 初始化程序变量-ict2429_Initial()初始化表结构：CDTABHTR（手工押单表）初始化开关：卡流水、帐务流水、总帐、柜员帐 ict2429_Verify()检查流水号、卡号、金额、商户号、终端号、授权日期、营业网点、操作员、授权操作员、授权号取消交易检查：本笔交易日必须为当前系统交易日。 ict2429_Process()1. 更新手工押单文件 CDTABHTR 帐务处理（分录）：取款金额（A）X，备用金户可用余额Y，TXY发生贷款时的分录借：中间科目 贷：特约商户 准备交易日志文件记录记帐务流水：actno、addr、name、curcd、avba

15、l、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 SERVERCLIENT数据界面 TOTA TEXT字段中文名称长度说明 F2429Name持卡人姓名30idtypew申请人证件种类的文字形式6gtlsrno帐务交易流水号6Gtlrcd授权柜员号6txdate授权日期8kinbr授权机构码5a

16、utnum授权号85.1.2.1.8 输出要素 显示卡号金额商户号终端号申权日期申权时间营业网点号营业人员号授权码5.1.2.1.9 本交易所涉及到的库表 贷记卡管理档（卡登记簿）cdm 贷款分户文件cccmr 备用金分户文件ccsmr5.2 数据流类模块【说明】 该类模块的特点是：接口通常是数据文件或XML的形式，接口文件内容比较稳定。5.2.1 数据流程图【内容】用数据流图（Data Flow Diagram-DFD）描述该功能模块总的数据流图。并给出文字说明。例如缴费管理模块总体数据流图：【裁剪原则】此部分内容不允许裁剪。注：此图为举例：5.2.2 实现说明5.2.2.1 功能点1实现说

17、明【内容】功能点实现说明包括以下一些内容： 功能定义 处理流程 业务规则（什么条件下能做什么事情，什么条件下不能做什么事情） 其他说明对“处理流程”，有两种图示方式：1)流程图方式（Flow Chart）；2)UML Sequence Diagram 方式。下图是一个缴费退费处理流程图方式示例。【裁剪原则】此部分内容不允许裁剪。注：此图为举例：5.2.2.2 功能点2实现说明【内容】如果有多个功能点，需要按照上述的方式，诸一说明。5.2.3 程序设计5.2.3.1 类定义【内容】说明类的定义，包括属性、接口函数等。【裁剪原则】此部分内容不允许裁剪。5.2.3.2 数据结构定义【内容】给出数据结

18、构或数据元素（变量）的特性，包括名称、标识符、数据类型和格式、值的有效范围，并给出定义性描述，最好能用类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