xxx项目详细设计说明书
(xxx模块)
拟制 评审人 批准 签发
yyyy-mm-dd
日期日期日期日期 详细设计说明书
文档修订记录
版本 V0.00 完成人 修改内容 创建文档 审核 批准 时间
第 2 页 共 10 页
详细设计说明书
目 录
1. 简介 5
1.1. 编写目的 ........................................................................................................................... 5 1.2. 适用范围 ........................................................................................................................... 5
1.2.1. 软件名称 ................................................................................................................ 5 1.2.2. 软件功能 ................................................................................................................ 5 1.2.3. 软件应用 ................................................................................................................ 5 1.3. 定义及关键词 .................................................................................................................... 5 1.4. 参考资料 ........................................................................................................................... 5 2. 子模块1设计描述 ........................................................................................................................ 6
2.1. 类xxx的设计 .................................................................................................................... 6
2.1.1. 简介 ....................................................................................................................... 6 2.1.2. 类图 ....................................................................................................................... 6 2.1.3. 状态设计(可选) ................................................................................................. 6 2.1.4. 属性 ....................................................................................................................... 6 2.1.5. 方法 ....................................................................................................................... 6
3. 数据库详细设计(可选) ............................................................................................................. 9
3.1. 存储过程#/触发器#的名称 ................................................................................................ 9 4. 错误处理..................................................................................................................................... 10
4.1. 系统错误 ......................................................................................................................... 10 4.2. 接口错误 ......................................................................................................................... 10 4.3. 协议错误 ......................................................................................................................... 10
第 3 页 共 10 页
详细设计说明书
表目录
表1. 表2. 表3.
关键词 ................................................................................................................................ 5 类XXX的属性 .................................................................................................................... 6 方法描述xxx-function ........................................................................................................ 7
图目录
图1 图2
类图xxx-class .................................................................................................................... 6 流程图xxx-function ............................................................................................................ 7
第 4 页 共 10 页
详细设计说明书
1. 简介 1.1. 编写目的
这部分要描述文档的目的,并指明文档的读者。
1.2. 适用范围 1.2.1. 软件名称
1.2.2. 软件功能
解释软件产品将完成或不完成的功能
1.2.3. 软件应用
描述软件的应用领域
1.3. 定义及关键词
表1. 关键词
关键词 英文全名 中文解释 1.4. 参考资料
[1]
第 5 页 共 10 页