XXXX 模块详细设计说明书 作者: 日期:
修订历史记录
日期 文档版本号 说明 作者
1. 引言 ............................................................................................................................................. 4
1.1 编写目的和范围 ................................................................................................................ 4 1.2 术语表................................................................................................................................ 4 1.3 参考资料............................................................................................................................ 4 2. 全局数据结构说明 ...................................................................................................................... 4
2.1 常量 ................................................................................................................................... 4 2.2 变量 ................................................................................................................................... 4 2.3 数据结构............................................................................................................................ 5 3. 模块设计...................................................................................................................................... 5
3.1 用例图................................................................................................................................ 5 3.2 功能设计说明 .................................................................................................................... 6
3.2.1 模块1...................................................................................................................... 6 3.2.2 模块2...................................................................................................................... 6
4. 接口设计...................................................................................................................................... 7
4.1 内部接口............................................................................................................................ 7 4.2 外部接口............................................................................................................................ 7
4.2.1 接口说明 ................................................................................................................. 7 4.2.2 调用方式 ................................................................................................................. 7
5. 数据库设计.................................................................................................................................. 8 6. 异常处理...................................................................................................................................... 8
1. 引言
1.1 编写目的和范围
说明写这份详细设计说明书的目的。
本详细设计说明书编写的目的是说明程序模块的设计考虑,包括程序描述、输入/输出、算法和流程逻辑等,为软件编程和系统维护提供基础。本说明书的预期读者为系统设计人员、软件开发人员、软件测试人员和项目评审人员。
1.2 术语表
定义系统或产品中涉及的重要术语,为读者在阅读文档时提供必要的参考信息。
序号 1 2 术语或缩略语 PM 说明性定义 Project Manager,项目经理 1.3 参考资料
列出相关的资料文档、需求说明书、架构说明书等。
2. 全局数据结构说明
2.1 常量
包括数据文件名称及其所在目录,功能说明,具体常量说明等。
2.2 变量
本章说明本程序系统中使用的全部数据常量、变量和数据结构。
2.3 数据结构
包括数据结构名称、功能说明、具体数据结构说明(定义、注释、取值)等
3. 模块设计
3.1 用例图
3.2 功能设计说明 3.2.1 模块1
3.2.1.1 设计图 3.2.1.2 功能描述 3.2.1.3 输入数据 3.2.1.4 输出数据 3.2.1.5 业务算法和流程 3.2.1.6 数据设计 3.2.1.7 源程序文件说明 3.2.1.8 函数说明 3.2.1.9 限制条件 3.2.1.10 其他说明
3.2.2 模块2
3.2.2.1 设计图 3.2.2.2 功能描述
3.2.2.3 输入数据 3.2.2.4 输出数据 3.2.2.5 业务算法和流程 3.2.2.6 数据设计 3.2.2.7 源程序文件说明 3.2.2.8 函数说明 3.2.2.9 限制条件 3.2.2.10 其他说明
4. 接口设计
4.1 内部接口 4.2 外部接口 4.2.1 接口说明
例如:XX子系统通过XX从XX子系统取得XX等。
4.2.2 调用方式
例如:内部接口调用: 例:
/**
*通过用户登陆,取得用户当前角色等,如果错误了,错误处理调用机制 **/
5. 数据库设计
数据库表结构、关联关系
6. 异常处理
模块异常了如何处理。
因篇幅问题不能全部显示,请点此查看更多更全内容