文档介绍：XXX产品XXX子系统
详细设计说明书
文件编号:
生效日期: 年月日
版本号:A
修改状态:0
受控状态: □受控□非受控
总页数:
附录:0
密级:机密
编制:
审核:
年月日
批准:
年月日
文档修订摘要
日期
版本号/状态
描述
著者
审阅者
批准人/日期
年月日
年月日
年月日
年月日
年月日
年月日
年月日
年月日
年月日
年月日
年月日
年月日
年月日
年月日
年月日
年月日
年月日
年月日
年月日
年月日
年月日
目录
1. 简介 5
目的 5
范围 5
定义、首字母缩写词和缩略语 5
参考资料 5
概述 5
2. 整体说明 6
子系统名称 6
子系统简要说明 6
子系统依赖关系 6
子系统职责 6
子系统设计约束 6
3. 用例实现 7
用例实现列表 7
用例实现 7
用例实现一 7
4. 接口实现 8
接口列表 8
接口实现 8
接口实现一 8
5. 子系统逻辑视图 8
逻辑视图 9
子系统分层一 9
类列表 9
类图 9
类描述 9
子系统设计包一 10
类列表 10
类图 10
类描述 10
6. 子系统实施视图 11
实施视图 11
实施子系统一 11
7. 其它设计 11
子系统集成设计 11
集成子系统设计 11
架构约定设计 12
其它设计 12
8. 补充说明 12
9. 附录A 约定 12
10. 附录B 附件 12
简介
子系统设计文档的简介应提供整个子系统设计文档的概述。它应包括此子系统设计文档的目的、范围、定义、首字母缩写词、缩略语、参考资料和概述。
目的
本节确定此子系统设计文档在整个项目文档中的作用或目的,并对此文档的结构进行简要说明。应确定此文档的特定读者,并指出他们应该如何使用此文档。
范围
简要说明此子系统设计文档适用的范围和影响的范围。
定义、首字母缩写词和缩略语
本小节应提供正确理解此子系统设计文档所需的全部术语的定义、首字母缩写词和缩略语。 这些信息可以通过引用项目词汇表来提供。
参考资料
本小节应完整地列出此子系统设计文档中其他部分所引用的所有文档。每个文档应标有标题、报告号(如果适用)、日期和出版单位。列出可从中获取这些参考资料的来源。这些信息可以通过引用附录或其他文档来提供。要求必须提供子系统的ROSE模型。
概述
本小节应说明此子系统设计文档中其他部分所包含的内容,并解释此子系统设计文档的组织方式
。
整体说明
子系统名称
在此说明此子系统的名称及编号。
子系统简要说明
在此简要说明此子系统的主角、目的或者内容。
子系统依赖关系
在此说明此子系统和其它子系统及包的依赖关系,要求说明依赖于其它子系统的接口以及提供给其它子系统的接口。要求有附图。
子系统职责
在此说明此子系统要完成的职责,以用例图的形式表达。对每个用例,要求有简短的描述。除了用例之外,还要说明此子系统提供的接口。
子系统设计约束
在此说明设计此子系统要考虑的问题、遵循的约束。比如要遵循软件架构设计的要求,要遵循需求中分配到此子系统的特殊要求,要遵循统一的界面约束(如果有的话),要使用架构统一设置的数据库源,要使用架构统一设置的JAVA MAIL等。
用例实现
用例实现列表
用例实现
用例
备注
编码
名称
编码
名称
注:对于每一个用例,可能有多个用例实现
如果不是很正式的话,那么编码这列可以省略不写。
用例实现
用例实现一
简介
在此对用例实现的简短说明。
用例实现描述
在此详细的说明此用例实现的描述。
顺序图
在此引用此用例实现的顺序图或者交互图。
类图
在此引用此用例实现的类图。
接口实现
接口列表
接口描述
接口
备注
编码
名称
类
方法
使用者
如果不是很正式的话,那么编码、使用者这2列可以省略不写。
接口实现
接口实现一
实现类
在此说明实现接口一的类及方法。最好用类图的形式来描述。
方法实现一
简介
对此方法的简短描述。
顺序图
在此引用此接口实现的顺序图或者交互图。
类图
在此引用此接口实现的类图。
子系统逻辑视图
即逻辑架构,为了容易理解,在此用逻辑分层来代替。在此说明此子系统的逻辑划分,现在