软件详细设计说明书模板.docVIP

FILENAME 编写规范例子（hw） 编号： 第 PAGE 4 页 共 NUMPAGES 7 页 保密级别 公开 版 本 号 V0.1 文档编号 CMMI 软件设计说明书模板 文档种类：CMMI 撰写时间：2006年 撰写部门：EPG组 发行范围：全公司 变更记录 版本号 修改点说明 变更人 存放位置 审批人 审批日期 修改点说明的内容有如下几种：创建、修改（+修改说明）、删除（+删除说明） FILENAME 软件设计说明书模板 编号： 第 PAGE 3 页 共 NUMPAGES 10 页 目 录 TOC \o 1-3 \h \z 1 概述 5 1.1 系统简述 5 1.2 软件设计目标 5 1.3 参考资料 5 2 术语表 5 3 设计概述 5 3.1 简述 5 3.2 系统结构设计 6 3.2.1 顶层系统结构 6 3.2.2 子系统1结构 6 3.2.3 子系统2结构 6 3.3 系统界面 6 3.4 约束和假定 6 4 对象模型 6 4.1 系统对象模型 6 5 对象描述 7 5.1 子系统1中的对象 7 5.1.1 对象：对象1 7 6 模块汇总 8 6.1 模块汇总表 8 6.2 模块关系图 8 7 子系统A的模块设计 9 7.1 n 模块A-n 9 8 动态模型 9 8.1 场景（Scenarios） 9 8.1.1 场景：场景1 9 8.2 状态图 10 8.2.1 状态图1： 10 9 非功能性需求 10 概述 系统简述 对系统要完成什么，所面向的用户以及系统运行的环境的简短描述，这部分主要来源于需求说明书的开始部分。 软件设计目标 这部分论述整个系统的设计目标，明确地说明哪些功能是系统决定实现而哪些时不准备实现的。同时，对于非功能性的需求例如性能、可用性等，亦需提及。需求规格说明书对于这部分的内容来说是很重要的参考，看看其中明确了的功能性以及非功能性的需求。 这部分必须说清楚设计的全貌如何，务必使读者看后知道将实现的系统有什么特点和功能。在随后的文档部分，将解释设计是怎么来实现这些的。 参考资料 列出本文档中所引用的参考资料。（至少要引用《产品需求规格说明书》） 术语表 对本文档中所使用的各种术语进行说明。如果一些术语在《产品需求规格说明书》中已经说明过了，此处不用再重复，可以指引读者参考《产品需求规格说明书》。 设计概述 本章节内容，如果在《软件概要设计说明书》中已经说明过了，此处不用再重复，可以指引读者参考《软件概要设计说明书》。 简述 这部分要求突出整个设计所采用的方法（是面向对象设计还是结构化设计）、系统的体系结构（例如客户/服务器结构）以及使用到的相应技术和工具（例如OMT、Rose）。 系统结构设计 这部分要求提供高层系统结构的描述，使用方框图来显示主要的组件及组件间的交互。最好是把逻辑结构同物理结构分离，对前者进行描述。别忘了说明图中用到的俗语和符号。 顶层系统结构 子系统1结构 子系统2结构 系统界面 各种提供给用户的界面以及外部系统在此处要予以说明。如果在需求规格说明书中已经对用户界面有了叙述，此处不用再重复，可以指引读者参考需求说明。如果系统提供了对其它系统的接口，比如说从其它软件系统导入/导出数据，必须在此说明。 约束和假定 描述系统设计中最主要的约束，这些是由客户强制要求并在产品需求说明书写明的。说明系统是如何来适应这些约束的。 另外如果本系统跟其它外部系统交互或者依赖其它外部系统提供一些功能辅助，那么系统可能还受到其它的约束。这种情况下，要求清楚地描述与本系统有交互的软件类型（比如某某某数据库软件，某某某EMail软件）以及这样导致的约束（比如只允许纯文本的Email）。 实现的语言和平台也会对系统有约束，同样在此予以说明。 对于因选择具体的设计实现而导致对系统的约束，简要地描述你的想法思路，经过怎么样的权衡，为什么要采取这样的设计等等。 如果采用面向对象的设计方法，可以参考4，5两章的方式。 对象模型 系统对象模型 提供整个系统的对象模型，如果模型过大，按照可行的标准把它划分成小块，例如可以把客户端和服务器端的对象模型分开成两个图表述。 对象图应该包含什么呢？在其中应该包含所有的系统对象。这些对象都是从理解需求后得到的。要明确哪些应该、哪些不应该被放进图中。所有对象之间的关联必须被确定并且必须指明联系的基数（一对一、一对多还是多对多，0..1，*，1..*）。聚合和继承关系必须清楚地确定下来。每个图必须附有简单的说明。可能经过多次反复之后才能得到系统的正确的对象模型。 对象描述 在这个