子系统设计文档模板

1、项目名称 子系统设计文档版本项目名称版本：子系统设计文档日期：修订历史记录日期版本说明作者日/月/年详细信息姓名目录 TOC o 1-5 h z HYPERLINK l bookmark46 o Current Document 简介5 HYPERLINK l bookmark50 o Current Document 目的5 HYPERLINK l bookmark54 o Current Document 范围5 HYPERLINK l bookmark58 o Current Document 定义、首字母缩写词和缩略语5 HYPERLINK l bookmark62 o Current

2、 Document 参考资料5 HYPERLINK l bookmark66 o Current Document 概述5 HYPERLINK l bookmark70 o Current Document 整体说明5 HYPERLINK l bookmark74 o Current Document 子系统名称5 HYPERLINK l bookmark78 o Current Document 子系统简要说明5 HYPERLINK l bookmark82 o Current Document 子系统依赖关系5 HYPERLINK l bookmark86 o Current Docume

3、nt 子系统职责5 HYPERLINK l bookmark90 o Current Document 子系统设计约束6 HYPERLINK l bookmark94 o Current Document 用例实现6 HYPERLINK l bookmark98 o Current Document 用例实现列表6用例实现63.2.1用例实现一6 HYPERLINK l bookmark104 o Current Document 接口实现7 HYPERLINK l bookmark107 o Current Document 接口列表7 HYPERLINK l bookmark110 o C

4、urrent Document 接口实现74.2.1接口实现一7 HYPERLINK l bookmark117 o Current Document 子系统逻辑视图7 HYPERLINK l bookmark121 o Current Document 逻辑视图7子系统分层一85.2.1类列表85.2. 2类图85.2.3类描述8子系统设计包一85.3.1类列表85.3.2类图85.3.3类描述8 HYPERLINK l bookmark129 o Current Document 子系统实施视图9 HYPERLINK l bookmark133 o Current Document 实施视

5、图9实施子系统一9 HYPERLINK l bookmark137 o Current Document 其它设计9 HYPERLINK l bookmark141 o Current Document 子系统集成设计9 HYPERLINK l bookmark145 o Current Document 集成子系统设计9 HYPERLINK l bookmark149 o Current Document 架构约定设计9 HYPERLINK l bookmark153 o Current Document 其它设计9 HYPERLINK l bookmark157 o Current Doc

6、ument 补充说明10附录A约定1010附录B附件子系统设计文档简介子系统设计文档的简介应提供整个子系统设计文档的概述。它应包括此子系统设计文档的目的、范围、定 义、首字母缩写词、缩略语、参考资料和概述目的本节确定此子系统设计文档在整个项目文档中的作用或目的，并对此文档的结构进行简要说明。应确定此 文档的特定读者，并指出他们应该如何使用此文档范围简要说明此子系统设计文档适用的范围和影响的范围定义、首字母缩写词和缩略语本小节应提供正确理解此子系统设计文档所需的全部术语的定义、首字母缩写词和缩略语。这些信息可以 通过引用项目词汇表来提供参考资料本小节应完整地列出此子系统设计文档中其他部分所引用的

7、所有文档。每个文档应标有标题、报告号（如 果适用）、日期和出版单位。列出可从中获取这些参考资料的来源。这些信息可以通过引用附录或其他文 档来提供。要求必须提供子系统的ROSE模型概述本小节应说明此子系统设计文档中其他部分所包含的内容，并解释此子系统设计文档的组织方式整体说明子系统名称在此说明此子系统的名称及编号子系统简要说明在此简要说明此子系统的主角、目的或者内容子系统依赖关系在此说明此子系统和其它子系统及包的依赖关系，要求说明依赖于其它子系统的接口以及提供给其它子系 统的接口。要求有附图子系统职责在此说明此子系统要完成的职责，以用例图的形式表达。对每个用例，要求有简短的描述。除了用例之外，还

8、要说明此子系统提供的接口子系统设计约束在此说明设计此子系统要考虑的问题、遵循的约束。比如要遵循软件架构设计的要求，要遵循需求中分配 到此子系统的特殊要求，要遵循统一的界面约束（如果有的话），要使用架构统一设置的数据库源，要使 用架构统一设置的JAVA MAIL等用例实现用例实现3.2.1用例实现一简介在此对用例实现的简短说明3.2.1.2用例实现描述在此详细的说明此用例实现的描述3.2.1.3顺序图在此引用此用例实现的顺序图或者交互图类图在此引用此用例实现的类图4.接口实现4.1 接口列表接口描述编码名称类接口备注方法使用者如果不是很正式的话，那么编码、使用者这2列可以省略不写接口实现4.2.

9、1接口实现一4.2.1.1实现类在此说明实现接口一的类及方法。最好用类图的形式来描述 4.2.1.2方法实现一（1）简介对此方法的简短描述（2）顺序图在此引用此接口实现的顺序图或者交互图（3）类图在此引用此接口实现的类图子系统逻辑视图即逻辑架构，为了容易理解，在此用逻辑分层来代替。在此说明此子系统的逻辑划分，现在一般来说，对 于子系统只进行分层，不再进一步的划分子系统。但是，如果需要进一步的划分子系统的话，那么对于在 其中划分出来的每一个子系统或者包，均需要此文档对其进行描述。子系统分层中如果包括界面层，那么在界面层应该加入界面设计，最好有一些图片或者是WORD画的示意图 来表示界面，同时要求

10、加入界面之间的导航关系，要求详细的说明界面的校验。根据实际使用的结果，界 面的导航关系、界面示意图、界面的校验是必须要求加入的子系统分层中如果包括数据层，那么在数据层应该加入数据库设计，最好有图形来表示数据库的设计，同 时要求有数据库的DDL语句，如果数据库需要初始化值的话，要求在DDL中包括初始化语句逻辑视图在此用图形的方式显示此子系统的分层、包之间的关系5.2子系统分层5.2.2类图在此可以引用ROSE模型中类图，类之间的关系、类的方法、类的属性也可以从此类图反映出来。如果不是 很正式的话，那么在类图中如果有类之间的关系、类的方法、类的属性的话，那么5.2.3可以省略5.2.3类描述此小节

11、可以根据项目实际限制条件进行取舍类一在此可以引用此类的源文件，如果引用源文件的话，那么以下的3项可以省略（1） 简介在此包括类的名称、类的描述（2） 属性名称类型访问限制初始化值描述（3） 方法名称访问限制输入参数返回值描述5.3子系统设计包一类图在此可以引用ROSE模型中类图，类之间的关系、类的方法、类的属性也可以从此类图反映出来。如果不是 很正式的话，那么在类图中如果有类之间的关系、类的方法、类的属性的话，那么5.3.3可以省略类描述此小节可以根据项目实际限制条件进行取舍类一在此可以引用此类的源文件，如果引用源文件的话，那么以下的3项可以省略（1） 简介在此包括类的名称、类的描述（2） 属

12、性名称类型访问限制初始化值描述（3） 方法名称访问限制输入参数返回值描述子系统实施视图实施视图在此用图形的方式显示此子系统的分层、包之间的关系其它设计子系统集成设计在此说明此子系统集成时的考虑，即将子系统集成成为那些包，各个包中包含那些构件。另外，在集成 时，还要考虑到软件架构的影响集成子系统设计在此说明将此子系统集成进安装时的考虑，即子系统安装时依赖其它那些子系统，在安装时要建立的数据 库的表、预先设置的数据、需要注册的值等。比如J2EE应用，要求在WEB.XML等配置文件中注册 Servlet、在J2EE服务器上预先建立数据库连接、在J2EE服务器上预先配置JAVA MAIL等。另外，在安装 时，还要考虑到软件架构的统一规定和约束架构约定设计在此说明子系统按照架构规定的设计约束进行设计的部分。比如架构规定每个子