软件详细设计说明书模板V1
- 格式：doc
- 大小：233.80 KB
- 文档页数：10
深圳市规划国土房产
信息中心 文档编号 SUPL-MANU-SDD-002
项目名称
项目来源
版 本 号 1.2 生效日期
详细设计说明书模板
修订历史
版本 说明 编制 批准 批准日期
1.0 初次编写 SEPG
1.2 初次修改 SEPG
软件详细设计说明书
仅供内部使用 第 i 页 目 录
1. 系统概述[可选] .......................................... 1
2. 软件结构 ................................................ 1
2.1. 软件结构图 ...................................................... 1
2.2. 对象关系模式图[适用于面向对象编程] [可选] ........................ 1
2.3. 模块清单 ........................................................ 1
3. 模块详细设计 ............................................ 2
3.1. 模块名称1（标识符） ............................................. 2
3.1.1. 模块描述 ...................................................... 2
3.1.2. 功能 .......................................................... 2
3.1.3. 性能[可选] .................................................... 2
3.1.4. 输入/输出 ..................................................... 2
3.1.5. 模块调用关系 .................................................. 3
3.1.6. 模块与需求对应关系 ............................................ 3
3.1.7. 角色与模块对应关系 ............................................ 3
3.1.8. 模块对表的操作关系 ............................................ 4
3.1.9. 流程逻辑[可选] ................................................ 4
3.1.10. 数据结构[可选] .............................................. 4
3.1.11. 算法[可选] .................................................. 4
3.1.12. 接口[可选] .................................................. 4
3.1.13. 用户界面设计[可选] .......................................... 5
3.1.14. 限制条件[可选] .............................................. 6
3.1.15. 尚未解决的问题[可选] ........................................ 6
3.1.16. 子模块设计[可选] ............................................ 6
3.2. 模块名称2（标识符） ............................................. 6
3.3. …… ............................................................ 6
4. 数据库详细设计 .......................................... 6 软件详细设计说明书
仅供内部使用 第 ii 页 4.1. E-R图 ........................................................... 6
4.2. TABLE清单 ........................................................ 7
4.3. TABLE设计说明 .................................................... 7 软件详细设计说明书
仅供内部使用 第 1 页 1. 系统概述[可选]
2. 概述项目背景和内容, 包括:
3. 项目的委托单位、开发单位、主管部门、与其它项目的关系, 与其他机构的关系, 预期用户等。
4. 软件结构
4.1. 软件结构图
4.2. 功能模块结构图, 主要表示模块间的调用关系
4.3. 对象关系模式图[适用于面向对象编程] [可选]
用图示的方式说明系统中各种公用类型的结构、类、接口、枚举的定义, 描述类、接口的关系。
IRuntimeEnve（接口类，从RuntimeEnve的实例QI）SetGraphSubSystem(ByRef pEditor As IEditor, ByValczGraphSystemCode As String, Optional ByRef bSubGraphSysEnabledAs Boolean = False) As BooleanGetConnection(ByRef pApp As IApplication, ByVal czBeauCode AsString) As ADODB.Connection示例对象读写属性只读属性只写属性有返回值的成员函数没有返回值的成员函数Class Diagram Key引用外部类或接口引用ArcObjects
4.4. 模块清单
编 号 模块名称 模块类型 模块标识符
软件详细设计说明书
仅供内部使用 第 2 页 5. 模块详细设计
5.1. 从本章开始, 逐个地给出各个层次中的每个模块的设计考虑。以下给出的提纲是针对一般情况的。对于一个具体的模块, 尤其是层次比较低的模块或子模块, 其很多条目的内容往往与它所隶属的上一层 模块的对应条目的内容相同, 在这种情况下, 只要简单地说明这一点即可。
5.2. 需要指出的是, 这里的模块是逻辑模块, 不一定对应一个确定的物理模块, 可能是几个物理模块的综合。
5.3. 模块名称1（标识符）
5.3.1. 模块描述
5.3.2. 给出对该模块的简要描述, 主要说明安排设计本模块的目的意义,
并且, 还要说明本模块的特点（如: 是常驻内存还是非常驻, 是否子模块, 是可重入的还是不可重入的, 有无覆盖要求, 是顺序处理还是并发处理等）。
5.3.3. 功能
5.3.4. 说明本模块应具有的功能, 可采用流程图形式或结构化语言描述模块处理逻辑。
5.3.5. 性能[可选]
5.3.6. 说明对该模块的全部性能要求, 包括对精度、灵活性和时间特性的要求。
5.3.7. 输入/输出
输入指输入参数和作为输入的数据文件的描述；输出指输出参数(含返回值)和修改的数据文件的描述。
给出对每一个输入/输出项的特性, 包括名称、标识、数据的类型和格式、数据值名称 标识符 类型 介质 来源 描述 软件详细设计说明书 仅供内部使用 第 3 页 的有效范围、输入的方式。 数量和频度、输入媒体、输入数据的来源和安全保密条件等等。
输入/输出
5.3.8. 模块调用关系
描述模块与其他模块、子模块间的调用关系。
5.3.9. 模块与需求对应关系
功能需求 覆盖程度
功能编号1 全部实现
功能功能2 部分实现
5.3.10. 角色与模块对应关系
角色名 权限
业务承办员 R、W 软件详细设计说明书
仅供内部使用 第 4 页
5.3.11. 模块对表的操作关系
数据库对象 类型 操作权限（R I U D）
AERRORCHN TABLE 1 0 0 0
5.3.12. 流程逻辑[可选]
用图表（例如流程图、判定表等）辅以必要的说明来表示本模块的逻辑流程
5.3.13. 数据结构[可选]
描述全局或局部数据结构:
名称 全局/局部 类型 使用方式 访问方式 描述
5.3.14. 算法[可选]
5.3.15. 详细说明本模块中的重要算法, 具体的计算公式和计算步骤。
5.3.16. 接口[可选]
用图或者表的形式说明本模块所隶属的上一层模块及隶属于本模块的属性/方法名 说明 输入 操作 输出 软件详细设计说明书
仅供内部使用 第 5 页 下一层模块、子模块,
说明参数赋值和调用方式。
序号
01
Application 只写属性, 设置ArcMap指针
pApp: ArcMap指针
02 FeatureLayer 只写属性, 设置操作图层
pFeatureLayer: 操作图层指针
…
frmAreaLine（面积定边窗体）Application As IApplicationFeatureLayer As IFeatureLayerFeature As IFeatureIsVersioned As Boolean示例对象读写属性只读属性只写属性有返回值的成员函数没有返回值的成员函数Class Diagram Key引用外部类或接口引用ArcObjects
5.3.17. 用户界面设计[可选]
用户界面布局图
（手工绘制的草图或者是屏幕抓取的系统原型）
