软件工程详细设计实例（面向对象软件设计说明书模板）.pdfVIP

软件详细设计说明书

面向对象软件设计说明书模板

1概述

1.1系统简述

对系统要完成什么，所面向的用户以及系统运行的环境的简短描述，这部分主要

来源于需求说明书的开始部分。

1.2软件设计目标

这部分论述整个系统的设计目标，明确地说明哪些功能是系统决定实现而哪些时

不准备实现的。同时，对于非功能性的需求例如性能、可用性等，亦需提及。需

求规格说明书对于这部分的内容来说是很重要的参考，看看其中明确了的功能性

以及非功能性的需求。

这部分必须说清楚设计的全貌如何，务必使读者看后知道将实现的系统有什么特

点和功能。在随后的文档部分，将解释设计是怎么来实现这些的。

1.3参考资料

列出本文档中所引用的参考资料。（至少要引用需求规格说明书）

1.4修订版本记录

列出本文档修改的历史纪录。必须指明修改的内容、日期以及修改人。

2术语表

对本文档中所使用的各种术语进行说明。如果一些术语在需求规格说明书中已经

说明过了，此处不用再重复，可以指引读者参考需求说明。

3用例

此处要求系统用用例图表述（UML），对每个用例（正常处理的情况）要有中文

叙述。

4设计概述

4.1简述

这部分要求突出整个设计所采用的方法（是面向对象设计还是结构化设计）、系

统的体系结构（例如客户/服务器结构）以及使用到的相应技术和工具（例如OMT、

Rose）

4.2系统结构设计

这部分要求提供高层系统结构的描述，使用方框图来显示主要的组件及组件间的

交互。最好是把逻辑结构同物理结构分离，对前者进行描述。别忘了说明图中用

到的俗语和符号。

4.2.1顶层系统结构

4.2.2子系统1结构

4.2.3子系统2结构

4.3系统界面

各种提供给用户的界面以及外部系统在此处要予以说明。如果在需求规格说明书

中已经对用户界面有了叙述，此处不用再重复，可以指引读者参考需求说明。如

果系统提供了对其它系统的接口，比如说从其它软件系统导入/导出数据，必须

在此说明。

4.4约束和假定

描述系统设计中最主要的约束，这些是由客户强制要求并在需求说明书写明的。

说明系统是如何来适应这些约束的。

另外如果本系统跟其它外部系统交互或者依赖其它外部系统提供一些功能辅助，

那么系统可能还受到其它的约束。这种情况下，要求清楚地描述与本系统有交互

的软件类型（比如某某某数据库软件，某某某EMail软件）以及这样导致的约束

（比如只允许纯文本的Email）。

实现的语言和平台也会对系统有约束，同样在此予以说明。

对于因选择具体的设计实现而导致对系统的约束，简要地描述你的想法思路，经

过怎么样的权衡，为什么要采取这样的设计等等。

5对象模型

5.1系统对象模型

提供整个系统的对象模型，如果模型过大，按照可行的标准把它划分成小块，例

如可以把客户端和服务器端的对象模型分开成两个图表述。

对象图应该包含什么呢？

在其中应该包含所有的系统对象。这些对象都是从理解需求后得到的。要明确哪

些应该、哪些不应该被放进图中。

所有对象之间的关联必须被确定并且必须指明联系的基数（一对一、一对多还是

多对多，0..1，*，1..*）。聚合和继承关系必须清楚地确定下来。每个图必须

附有简单的说明。

可能经过多次反复之后才能得到系统的正确的对象模型。

6对象描述

在这个部分叙述每个对象的细节，它的属性、它的方法。在这之前必须从逻辑上

对对象进行组织。你可能需要用结构图把对象按子系统划分好。

为每个对象做一个条目。在系统对象模型中简要的描述它的用途、约束（如只能

有一个实例），列出它的属性和方法。如果对象是存储在持久的数据容器中，标

明它是持久对象，否则说明它是个临时对象（transientobject）。

对每个对象的每个属性详细说明：名字、类型，如果属性不是很直观或者有约束

（例如，每个对象的该属性必须有一个唯一的值或者值域是有限正整数等）。

对每个对象的每个方法详细说明：方法名，返回类型，返回值，参数，用途以及

使用的算法的简要说明（如果不是特别简单的话）。如果对变量或者返回值由什

么假定的话，Pre-conditions和Post-conditions必须在此说明。列出它或者

被它调用的方法需要访问或者修改的属性。最后，提供可以验证实现方法的测试

案例。

6.1子系统1中的对象

6.1.1对象：对象1

用途：

约束：

持久性：

6.1.1.1属性描述：

1.属性：属性1

类型：

描述：

约束：

2