软件详细设计说明书
西安研发中心
密级:普通
<项目名称-子系统> 项目编号:XXXXX
文档编号: 作 者: 评 审: 审 核: 批 准: 文档状态:
软件详细设计说明书 当前版本: 编写日期: 评审日期: 审核日期:
批准日期: 草稿/发布版
变更次数:
All rights reserved
版权所有,侵权必究
第 1 页 共 6 页
软件详细设计说明书
文档修订记录
章节编号 1 初始建立。 版本号 修订内容简述 修订日期 作者 第 2 页 共 6 页
软件详细设计说明书
目 录
1 简介........................................................................................................................ 4
1.1 1.2 1.3 1.4 1.5
目的................................................................................................................. 4 范围................................................................................................................. 4 定义、首字母缩写词和缩略语 .......................................................................... 4 参考资料.......................................................................................................... 4 文档结构.......................................................................................................... 4
2 子系统功能设计.................................................................................................... 4
2.1 2.2
子系统功能分解结构 ........................................................................................ 4 XXX模块 .......................................................................................................... 4
2.2.1 2.2.2
功能描述.................................................................................................. 4 模块设计描述........................................................................................... 5
类图(可选)................................................................................... 5 类描述 ............................................................................................. 5
2.2.2.1 2.2.2.2
2.2.2.2.1 Class XXX........................................................................................ 5 2.2.2.2.1.1 数据成员/属性 .......................................................................... 5 2.2.2.2.1.2 方法 ......................................................................................... 5 2.2.2.2.1.3 实现描述(可选) .................................................................... 6
2.2.3 功能实现说明........................................................................................... 6
3 异常处理................................................................................................................ 6
3.1 3.2 3.3
系统错误.......................................................................................................... 6 接口错误.......................................................................................................... 6 协议错误.......................................................................................................... 6
第 3 页 共 6 页
软件详细设计说明书
1 简介
1.1 目的
[阐明此文档的编写目的。]
1.2 范围
[简要说明此文档描述的内容范围,比如:软件实现的功能或不实现的功能,软件的应用领域等。]
1.3 定义、首字母缩写词和缩略语
[本小节应提供正确理解此文档所需的全部术语的定义、首字母缩写词和缩略语。 这些信息可以通过引用项目词汇表来提供。]
1.4 参考资料
[本小节应完整列出此文档中所引用的任何文档。列出可从中获取这些参考资料的来源。这些信息可以通过引用附录或其他文档来提供。]
1.5 文档结构
[本小节说明系统详细设计说明书的文档组成,比如:如果按子系统或模块分解编写详细设计说明书,那么此处列举所有的详细设计文档。]
2 子系统功能设计
[这一节应针对子系统的功能分解结构,结合所采用的设计方案,对软件功能的设计实现做详细说明]
2.1 子系统功能分解结构
[这一节简要说明软件系统的功能分解结构(比如:子系统-模块-执行单元)] 【对每个模块重复使用下面的格式】
2.2 XXX模块
[此节说明模块XXX的分解,包括模块的功能定义、设计类、以及采用的设计模式等]
2.2.1 功能描述
[这一节简要描述模块的功能,并采用列表的形式跟踪。如果采用UML的用例描述系统的功能,可以列出该模块包含的用例]
eg:
第 4 页 共 6 页
相关推荐: