详细设计说明书

项目详细设计说明书
目录
1引言 (1)
1.1编写目的 (1)
1.2编写背景 (1)
1.2.1系统名称及版本号 (1)
1.2.2任务提出者 (1)
1.2.3任务承接者及实施者 (1)
1.2.4使用者 (1)
1.2.5与其它子系统的关系 (1)
1.3文档概述 (2)
1.3.1文档结构说明 (2)
1.3.2电子文档编写工具 (2)
1.3.3定义说明与符号 (2)
1.3.4参考资料 (2)
2功能概述 (2)
2.1功能模块命名原则 (2)
2.2功能层次图 (2)
2.3功能模块与部门的对应关系 (4)
2.4本子系统的外部接口 (4)
3数据库设计 (5)
3.1代码表列表 (5)
3.2实体集列表 (5)
3.3实体与表之间的对应关系 (5)
3.4物理数据模型图 (6)
3.5表属性描述 (8)
3.6数据量分布 (9)
3.7数据存储与访问分析 (9)
3.8安全保密措施 (9)
4功能模块详述 (10)
4.1模块1 (10)
4.2模块2 (13)
4.3模块3 (13)
1引言
1.1编写目的
【说明】设计对象：系统的某个子系统。

原则上，每个子系统的详细设计应单独装订成册；
但对于比较小的子系统，容许合并成一册。

预期读者：我公司与用户方的开发人员、双方的系统维护人员。

作用：承上启下。

基于概要设计，为下一阶段的程序编码工作提供依据。

它是项
目验收的重要内容和后期维护的必备资料。

1.2编写背景
1.2.1系统名称及版本号
【说明】形如“北京市地方税务局管理信息系统——申报征收子系统 V3.0”。

其中，版本号的格式为“XX.XX”，X为阿拉伯数字，左“0”可省略。

1.2.2任务提出者
【说明】指承担《质量保证计划》中规定的我方领导机构或项目负责人。

1.2.3任务承接者及实施者
【说明】指承担本子系统详细设计的负责人及工作人员名单。

1.2.4使用者
【说明】主要指预期读者，也供有关领导审阅。

1.2.5与其它子系统的关系
【说明】给本子系统在整个系统中准确定位，用功能层次图及相应的文字予以说明。

1.3文档概述
1.3.1文档结构说明
【说明】章节划分原则、内容的取舍、重点的确定等。

1.3.2电子文档编写工具
【说明】工具名、版本号、操作系统平台。

使用多种工具时，应分别说明。

形如：Microsoft Office2003
Power Designer 9.5
Visio2003
1.3.3定义说明与符号
【说明】包括对专用术语及缩略语的解释、所用到的图（物理数据模型图/功能层次图/逻辑框图/流程图等）中图符的表示与解释、屏幕界面中图标与按钮的表示与含义等。

1.3.4参考资料
【说明】格式：作者，[版本号]，资料来源，日期，[起止页号]。

其中，《需求规格说明书》与《概要设计说明书》是必选的参考资料。

2功能概述
2.1功能模块命名原则
【说明】名字（即标识符）：一般采用英文或汉语拼音。

要求有实际意义、便于理解、最好有规律可循。

参看《概要设计说明书》并注意与之保持一致。

2.2功能层次图
【说明】自顶向下，逐层分解，直至叶（即末端）功能模块。

在每个子系统中，功能模块的编号是唯一的。

推荐的编号原则为：
子系统(第0层)…………………无编号
第1层子模块……………………X
第2层子模块……………………XX
第3层子模块……………………XXX
第4层子模块……………………XXXX
……………………………
其中，X可为阿拉伯数字1-9（不许出现0），或大写英文字母A-Z（对应于10-35），或小写英文字母a-z（对应于36-61）。

必要时还可用希腊字母接续。

例如：
“6”表示本子系统中编号为6的第1层子模块。

“63”表示在编号为6的第1层子模块下，编号为3的第2层子模块。

“63B”表示在编号为6的第1层子模块下，编号为3的第2层子模块下，编号为11的第3层子模块。

以下类推。

这种编号原则的优点是模块编号比较短。

如果使用形如“6.3.11”的形式还容易与相同形式的标题编号混淆。

为顾及用户的习惯，我们也容许使用形如“6.3.11”的模块编号形式
功能模块图的格式举例：
第一层子模块还可以再继续分解。

如编号为3的子模块可分解为：
2.3 功能模块与部门的对应关系
【说明】使用矩阵方式，说明用户单位的各个部门使用功能模块的情况。

“ ”表示使用了该模块，“ ”表示未使用。

其中的模块名可以是任意层次上的，最好与实际安装相对应。

形如：
2.4 本子系统的外部接口
【说明】与其它子系统的接口：数据/参数的调用/返回情况。

对特殊外部设备的需求：如扫描仪、数字化仪、条码设备、磁卡设备、票据打印机、调制解调器等。

计划管理子系统 2 分单位计划分配 3 计划查询 3 计划查询 31 单项查询 32 组合查询 323 显示结果
322 快速检索 321 表达式处理 4 计划报表
1 分税种计划分配
这里应对各个接口（含数据接口与功能接口）逐一详细说明。

3数据库设计
3.1代码表列表
【说明】参看《概要设计说明书》。

指出本子系统使用的代码表的列表。

形如：
代码表列表
中文注释里应确定该代码表在本子系统中的位置（公用/专用）。

还应指明描述代码数据的文档名称与文档编号。

3.2实体集列表
【说明】分为系统公用实体列表与本子系统专用实体列表两类,源于概要设计。

形如：
子系统公用实体列表
子系统专用实体列表
3.3实体与表之间的对应关系
【说明】概念对象实体（Entity）对应的物理对象为表（Table）。

实体属性（Entity attribute）对应的是表的列（Table column）。

标识符（Identifier）对应的是主键或外键（Foreign Key/ Primary Key,
取决是独立还是依赖关系）。

关系（Relationship）对应的是参照（Refrence）。

实体与表二者之间的对应关系，用表格简述如下：
3.4物理数据模型图
【说明】物理数据模型即PDM（Physical Data Model）。

它详细说明了数据库的物理实现。

在这里，我们将具体考虑物理实现的细节，包括数据的存储结构。

可以通过修改PDM来适应性能/物理上的约束。

PDM的主要作用是：以图形方式描绘出数据的物理组织结构；进行数据库的创建和修改；定义参照完整性；生成扩展属性；可以通过逆向工程重新产生CDM(Conceptual Data Model)。

建议使用Power Designer 9.0（或更高版本）绘制，应该保持PDM与相应 CDM在逻辑上的一致性。

具体要求可参看《概要设计说明书》中的有关内容。

这里特别值得注意的是：Power-Designer可以使用脚本和通过ODBC驱动来创建和修改数据库。

如果在实际过程中实施了这个步骤，应在《详细设计说明书》里有所反映。

项目管理表关系图
3.5表属性描述
【说明】本子系统专用的表描述。

可以采取两种方式：
表格+文字描述（推荐）
建表文件
表格形如：
无论采取哪种方式，都必须说明：索引表达式与索引文件（如果存在）、参照的定义与完整性保证。

对重要的列，应补充说明其含义与使用须知。

对于视图的描述，可类比进行。

3.6数据量分布
【说明】使用表格+文字的方式描述。

形如：
总字节数=各表最大字节数之和。

预计字节数=总字节数×占空系数
其中，占空系数表示实际开销与理论开销之比。

其比值可根据具体项目及运行环境而定，如可取1.5至2.5。

3.7数据存储与访问分析
【说明】采用表格方式，应与数据量分布表对应。

形如：
3.8安全保密措施
【说明】进行角色定义，说明各类角色的权限；
备份（包括安全性备份与历史备份）的要求与操作步骤；
日志文件的使用情况；
解决“千年虫”问题的办法；
防治计算机病毒的措施等。

4功能模块详述4.1模块1
4.2模块2 4.3模块3 ……。