详细设计说明书模版.docx

: .
（项目名称）
详细设计说明书
文件版本
编写日期
发布日期
文件修改记录
引言
编写目的
【说明编写这份文档的目的，指出预期的读者。】
适用范围
【说明此文档在何种情况下或何种工作中使用。】
术语和缩写
【列出本文件中用到的专门术语的定义和外文首字母组词的原词组以及中英文全称。】
参考资料
【列出有关参考资料。】
概述
【如果没有划分子系统，此章节可裁剪。】
系统概述
【说明此（子）系统“是什么”1
系统功能定义
【说明此（子）系统实现的主要功能，可以诸条说明。】
总体结构说明
系统结构
系统内外部关系图
【描述此（子）系统内部功能模块的构成以及与外部模块的接口关系，可采用图表形式。如果《概要设计说明书》已描述此部分内容，此处可删剪。】
功能模块简要说明
【对此（子）系统功能模块做简要说明。如果《概要设计说明书》已描述此部分内容，此处可删剪。】
依赖的外部接口
【说明各模块依赖的外部接口是什么，输入参数、输出参数、返回值等。】
对外提供的接口
【说明各模块对外提供的外部接口是什么，输入参数、输出参数、返回值等。】
模块程序构件结构图
【详细描述程序构件结构图，并做文字说明。一般是有如下两种情况需做此描述：
非中间件服务结构的后台处理进程模块（一般是异步操作等）。
在前台交互式操作的模块中，引入了非中间件服务结构的部件。如：】
8、连接数据库
数据模型（DataModel）设计
逻辑实体模型
实体模型1
【描述本（子）系统核心的实体关系模型。如下图所示。要求做到：
描述每一个实体的作用，指定实体标识（ID）。
对每一个relationship都要有说明，同时严格注意Mandatory（是否必须），
Cardinality（几对几关系）。
ER图中的每个表中应有表名、主键字段名、重要字段名等信息。重要字段虽然不是ER图本身必须的，但可以更利于理解表的属性和关系。】
父子关系
实体模型2
【如果有多个实体模型，需要按照上述的方式，诸一说明。】
表结构（物理设计）
【此部分主要设计表结构。一般地，实体对应于表，实体的属性对应于表的列，实体之间的关系成为表的约束。逻辑设计中的实体大部分可以转换成为物理设计中的表，但是他们并不一定
是一一对应的。】
表汇总
序号
（子）系统
表名
中文名称和简单描述
使用方式
1
2
3
【注：使用方式分为：公用（所有（子）系统均可访问）、自用（仅本（子）系统可访问）
临时。1
表1
字段名
数据类型
空/非空
其他
字段简单描述
表描述
【基本用途、所属数据库、表数据量、预计增长量。
所属表空间、分表说明、分区说明。】
主键
外键
主表：
外部引用
主表：
,,
索引
,,
,,
触发器
,,
,,
约束
字段
描述
字段1
【字段描述】
字段2
【字段描述】
,,
【字段描述】

【同上。】

序
号
（子）
系统
视图名
相关表
使用
方式
描述
1
2
3
【注：使用方式分为：公用（其他（子）系统可访问）、自用（仅（本）子系统可访问）、临
时。】
功能实现说明
【本章对每个功能模块中的每一个功能点做实现说明。有两类主要的应用：以数据流为核心
的，处理流程是重点；以业务操作为核心的，后台业务模型、前台展现模型是重点（强调用对象模型设计）。下面用不同的章节分别给出这两类应用的设计文档模板。】
数据流类模块
【说明：该类模块的特点是：接口通常是数据文件或XML勺形式，接口文件内容比较稳定。】
数据流程图
【用数据流图（DataFlowDiagram-DF。描述该功能模块总的数据流图。并给出文字说明。】
实现说明
5 功能点1实现说明
【功