软件设计3个模板之2详细设计说明书模板Word文档格式.docx

软件设计3个模板之2详细设计说明书模板Word文档格式.docx

《软件设计3个模板之2详细设计说明书模板Word文档格式.docx》由会员分享，可在线阅读，更多相关《软件设计3个模板之2详细设计说明书模板Word文档格式.docx（9页珍藏版）》请在冰豆网上搜索。

年月日

批准：

文档修订摘要

日期

版本号/状态

描述

著者

审阅者

批准人/日期

目录

1.简介5

1.1目的5

1.2范围5

1.3定义、首字母缩写词和缩略语5

1.4参考资料5

1.5概述5

2.整体说明6

2.1子系统名称6

2.2子系统简要说明6

2.3子系统依赖关系6

2.4子系统职责6

2.5子系统设计约束6

3.用例实现7

3.1用例实现列表7

3.2用例实现7

3.2.1用例实现一7

4.接口实现8

4.1接口列表8

4.2接口实现8

4.2.1接口实现一8

5.子系统逻辑视图8

5.1逻辑视图9

5.2子系统分层一9

5.2.1类列表9

5.2.2类图9

5.2.3类描述9

5.3子系统设计包一10

5.3.1类列表10

5.3.2类图10

5.3.3类描述10

6.子系统实施视图11

6.1实施视图11

6.2实施子系统一11

7.其它设计11

7.1子系统集成设计11

7.2集成子系统设计11

7.3架构约定设计12

7.4其它设计12

8.补充说明12

9.附录A约定12

10.附录B附件12

1.简介

子系统设计文档的简介应提供整个子系统设计文档的概述。

它应包括此子系统设计文档的目的、范围、定义、首字母缩写词、缩略语、参考资料和概述。

目的

本节确定此子系统设计文档在整个项目文档中的作用或目的，并对此文档的结构进行简要说明。

应确定此文档的特定读者，并指出他们应该如何使用此文档。

范围

简要说明此子系统设计文档适用的范围和影响的范围。

定义、首字母缩写词和缩略语

本小节应提供正确理解此子系统设计文档所需的全部术语的定义、首字母缩写词和缩略语。

这些信息可以通过引用项目词汇表来提供。

参考资料

本小节应完整地列出此子系统设计文档中其他部分所引用的所有文档。

每个文档应标有标题、报告号（如果适用）、日期和出版单位。

列出可从中获取这些参考资料的来源。

这些信息可以通过引用附录或其他文档来提供。

要求必须提供子系统的ROSE模型。

概述

本小节应说明此子系统设计文档中其他部分所包含的内容，并解释此子系统设计文档的组织方式。

2.整体说明

子系统名称

在此说明此子系统的名称及编号。

子系统简要说明

在此简要说明此子系统的主角、目的或者内容。

子系统依赖关系

在此说明此子系统和其它子系统及包的依赖关系，要求说明依赖于其它子系统的接口以及提供给其它子系统的接口。

要求有附图。

子系统职责

在此说明此子系统要完成的职责，以用例图的形式表达。

对每个用例，要求有简短的描述。

除了用例之外，还要说明此子系统提供的接口。

子系统设计约束

在此说明设计此子系统要考虑的问题、遵循的约束。

比如要遵循软件架构设计的要求，要遵循需求中分配到此子系统的特殊要求，要遵循统一的界面约束（如果有的话），要使用架构统一设置的数据库源，要使用架构统一设置的JAVAMAIL等。

3.用例实现

用例实现列表

用例实现

用例

备注

编码

名称

注：

对于每一个用例，可能有多个用例实现

如果不是很正式的话，那么编码这列可以省略不写。

用例实现一

简介

在此对用例实现的简短说明。

用例实现描述

在此详细的说明此用例实现的描述。

顺序图

在此引用此用例实现的顺序图或者交互图。

类图

在此引用此用例实现的类图。

4.接口实现

接口列表

接口描述

接口

类

方法

使用者

如果不是很正式的话，那么编码、使用者这2列可以省略不写。

接口实现

接口实现一

实现类

在此说明实现接口一的类及方法。

最好用类图的形式来描述。

方法实现一

（1）简介

对此方法的简短描述。

（2）顺序图

在此引用此接口实现的顺序图或者交互图。

（3）类图

在此引用此接口实现的类图。

5.子系统逻辑视图

即逻辑架构，为了容易理解，在此用逻辑分层来代替。

在此说明此子系统的逻辑划分，现在一般来说，对于子系统只进行分层，不再进一步的划分子系统。

但是，如果需要进一步的划分子系统的话，那么对于在其中划分出来的每一个子系统或者包，均需要此文档对其进行描述。

子系统分层中如果包括界面层，那么在界面层应该加入界面设计，最好有一些图片或者是WORD画的示意图来表示界面，同时要求加入界面之间的导航关系，要求详细的说明界面的校验。

根据实际使用的结果，界面的导航关系、界面示意图、界面的校验是必须要求加入的。

子系统分层中如果包括数据层，那么在数据层应该加入数据库设计，最好有图形来表示数据库的设计，同时要求有数据库的DDL语句，如果数据库需要初始化值的话，要求在DDL中包括初始化语句。

逻辑视图

在此用图形的方式显示此子系统的分层、包之间的关系。

子系统分层一

类列表

如果不是很正式的话，那么编码这1列可以省略不写。

在此可以引用ROSE模型中类图，类之间的关系、类的方法、类的属性也可以从此类图反映出来。

如果不是很正式的话，那么在类图中如果有类之间的关系、类的方法、类的属性的话，那么5.2.3可以省略。

类描述

此小节可以根据项目实际限制条件进行取舍。

类一

在此可以引用此类的源文件，如果引用源文件的话，那么以下的3项可以省略。

在此包括类的名称、类的描述。

（2）属性

类型

访问限制

初始化值

（3）方法

输入参数

返回值

子系统设计包一

如果不是很正式的话，那么在类图中如果有类之间的关系、类的方法、类的属性的话，那么5.3.3可以省略。

6.子系统实施视图

实施视图

实施子系统一

构件

对应的设计类

在JAVA开发的系统中，实施子系统通常以目录的形式出现。

7.其它设计

子系统集成设计

在此说明此子系统集成时的考虑，即将子系统集成成为那些包，各个包中包含那些构件。

另外，在集成时，还要考虑到软件架构的影响。

集成子系统设计

在此说明将此子系统集成进安装时的考虑，即子系统安装时依赖其它那些子系统，在安装时要建立的数据库的表、预先设置的数据、需要注册的值等。

比如J2EE应用，要求在WEB.XML等配置文件中注册Servlet、在J2EE服务器上预先建立数据库连接、在J2EE服务器上预先配置JAVAMAIL等。

另外，在安装时，还要考虑到软件架构的统一规定和约束。

架构约定设计

在此说明子系统按照架构规定的设计约束进行设计的部分。

比如架构规定每个子系统必须提供的内容等。

其它设计

在此说明不包含在以上的其它设计内容。

8.补充说明

在此说明其它需要说明的设计内容。

比如说安装、发布、升级等。

9.附录A约定

在此包括各种设计上的约定，比如命名约定等。

10.附录B附件

在此附上各种需要的文档。

比如子系统的建表语句、预先设置的数据的SQL语句、注册的SQL语句、注册到web.xml的语句、Servlet的注册语句、预先建立的此子系统的代码框架（从ROSE导出的）等。