《详细设计说明书》由会员分享，可在线阅读，更多相关《详细设计说明书（4页珍藏版）》请在金锄头文库上搜索。
1、1引言1.1编写目的：阐明编写详细设计说明书的目的，指明读者对象。1.2项目背景：应包括项目的来源和主管部门等。1.3定义：列出本文档中所用到的专门术语的定义和缩写词的愿意。1.4参考资料：列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源项目经核准的计划任务书、合同或上级机关的批文；项目开发计划；需求规 格说明书；概要设计说明书；测试计划（初稿）；用户操作手册文档所引用的资料、软件开发的标准或规范。2总体设计2.1需求概述2.2软件结构：如给出软件系统的结构图。3程序描述3.1逐个模块给出以下说明：功能性能输入项目输出项目3.2算法：模块所选用的算法。3.3程序逻辑：详细描述模块实
2、现的算法，可采用：标准流程图；PDL语言；N-S 图；判定表等描述算法的图表。3.4 接口存储分配限制条件3.5测试要点：给出测试模块的主要测试要求。1概述1.1系统简述对系统要完成什么，所面向的用户以及系统运行的环境的简短描述，这部分主要来 源于需求说明书的开始部分。1.2软件设计目标这部分论述整个系统的设计目标，明确地说明哪些功能是系统决定实现而哪些时不 准备实现的。同时，对于非功能性的需求例如性能、可用性等，亦需提及。需求规 格说明书对于这部分的内容来说是很重要的参考，看看其中明确了的功能性以及非 功能性的需求。这部分必须说清楚设计的全貌如何，务必使读者看后知道将实现的系统有什么特点 和
3、功能。在随后的文档部分，将解释设计是怎么来实现这些的。1.3参考资料列出本文档中所引用的参考资料。（至少要引用需求规格说明书）1.4修订版本记录列出本文档修改的历史纪录。必须指明修改的内容、日期以及修改人。2术语表对本文档中所使用的各种术语进行说明。如果一些术语在需求规格说明书中已经说 明过了，此处不用再重复，可以指引读者参考需求说明。3用例此处要求系统用用例图表述（UML），对每个用例（正常处理的情况）要有中文叙述。4设计概述4.1简述这部分要求突出整个设计所采用的方法（是面向对象设计还是结构化设计）、系统 的体系结构（例如客户/服务器结构）以及使用到的相应技术和工具（例如OMT、Rose）
4、 4.2系统结构设计这部分要求提供高层系统结构的描述，使用方框图来显示主要的组件及组件间的交 互。最好是把逻辑结构同物理结构分离，对前者进行描述。别忘了说明图中用到的 俗语和符号。4.2.1顶层系统结构4.2.2子系统1结构4.2.3子系统2结构4.3系统界面各种提供给用户的界面以及外部系统在此处要予以说明。如果在需求规格说明书中 已经对用户界面有了叙述，此处不用再重复，可以指引读者参考需求说明。如果系 统提供了对其它系统的接口，比如说从其它软件系统导入/导出数据，必须在此说 明。4.4约束和假定描述系统设计中最主要的约束，这些是由客户强制要求并在需求说明书写明的。说 明系统是如何来适应这些约
5、束的。另外如果本系统跟其它外部系统交互或者依赖其它外部系统提供一些功能辅助，那 么系统可能还受到其它的约束。这种情况下，要求清楚地描述与本系统有交互的软 件类型（比如某某某数据库软件，某某某EMail软件）以及这样导致的约束（比如 只允许纯文本的Email）。实现的语言和平台也会对系统有约束，同样在此予以说明。对于因选择具体的设计实现而导致对系统的约束，简要地描述你的想法思路，经过怎么样的权衡，为什么要采取这样的设计等等。5对象模型5.1系统对象模型提供整个系统的对象模型，如果模型过大，按照可行的标准把它划分成小块，例如 可以把客户端和服务器端的对象模型分开成两个图表述。对象图应该包含什么呢？
6、在其中应该包含所有的系统对象。这些对象都是从理解需求后得到的。要明确哪些 应该、哪些不应该被放进图中。所有对象之间的关联必须被确定并且必须指明联系的基数（一对一、一对多还是多 对多，0.1，*，1.*）。聚合和继承关系必须清楚地确定下来。每个图必须附有简 单的说明。可能经过多次反复之后才能得到系统的正确的对象模型。6对象描述在这个部分叙述每个对象的细节，它的属性、它的方法。在这之前必须从逻辑上对 对象进行组织。你可能需要用结构图把对象按子系统划分好。为每个对象做一个条目。在系统对象模型中简要的描述它的用途、约束（如只能有 一个实例），列出它的属性和方法。如果对象是存储在持久的数据容器中，标明它
7、 是持久对象，否则说明它是个临时对象（transient object）。对每个对象的每个属性详细说明：名字、类型，如果属性不是很直观或者有约束（例 如，每个对象的该属性必须有一个唯一的值或者值域是有限正整数等）。对每个对象的每个方法详细说明：方法名，返回类型，返回值，参数，用途以及使 用的算法的简要说明（如果不是特别简单的话）。如果对变量或者返回值由什么假 定的话，Pre-conditions和Post-conditions必须在此说明。列出它或者被它调用 的方法需要访问或者修改的属性。最后，提供可以验证实现方法的测试案例。6.1子系统1中的对象6.1.1对象：对象1用途：约束：持久性：6.1.1.1属性描述：1. 属性：属性1类型：描述：约束：2. 属性：属性26.1.1.2方法描述:1.方法：方法1返回类型：参数：返回值：Pre-Condition：
