《概要设计说明书》编写指南1.docVIP

该文档收集他人文档而来： 一、问题的提出 概要设计写什么？概要设计怎么做？ 如何判断设计的模块是完整的？ 为什么说设计阶段过于重视业务流程是个误区？ 以需求分析文档还是以概要设计文档来评估开发工作量、指导开发计划准确？ 结构化好还是面向对象好？ 以上问题的答案请在文章中找。 二、概要设计的目的 将软件系统需求转换为未来系统的设计； 逐步开发强壮的系统构架； 使设计适合于实施环境，为提高性能而进行设计； 结构应该被分解为模块和库。 三、概要设计的任务 制定规范：代码体系、接口规约、命名规则。这是项目小组今后共同作战的基础，有了开发规范和程序模块之间和项目成员彼此之间的接口规则、方式方法，大家就有了共同的工作语言、共同的工作平台，使整个软件开发工作可以协调有序地进行。 总体结构设计： 功能（加工）－模块：每个功能用那些模块实现，保证每个功能都有相应的模块来实现； 模块层次结构：某个角度的软件框架视图； 模块间的调用关系：模块间的接口的总体描述； 模块间的接口：传递的信息及其结构； 处理方式设计：满足功能和性能的算法 用户界面设计； 数据结构设计： 详细的数据结构：表、索引、文件； 算法相关逻辑数据结构及其操作； 上述操作的程序模块说明（在前台？在后台？用视图？用过程？······） 接口控制表的数据结构和使用规则 其他性能设计。 四、概要设计写什么 结构化软件设计说明书结构 任务：目标、环境、需求、局限； 总体设计：处理流程、总体结构与模块、功能与模块的关系； 接口设计：总体说明外部用户、软、硬件接口；内部模块间接口（注：接口≈系统界面） 数据结构：逻辑结构、物理结构，与程序结构的关系； 模块设计：每个模块“做什么”、简要说明“怎么做”（输入、输出、处理逻辑、与其它模块的接口，与其它系统或硬件的接口），处在什么逻辑位置、物理位置； 运行设计：运行模块组合、控制、时间； 出错设计：出错信息、处错处理； 其他设计：保密、维护； OO软件设计说明书结构 1 概述 ???统简述、软件设计目标、参考资料、修订版本记录 这部分论述整个系统的设计目标，明确地说明哪些功能是系统决定实现而哪些不准备实现的。同时，对于非功能性的需求例如性能、可用性等，亦需提及。需求规格说明书对于这部分的内容来说是很重要的参考，看看其中明确了的功能性以及非功能性的需求。 这部分必须说清楚设计的全貌如何，务必使读者看后知道将实现的系统有什么特点和功能。在随后的文档部分，将解释设计是怎么来实现这些的。 2 术语表 对本文档中所使用的各种术语进行说明。如果一些术语在需求规格说明书中已经说明过了，此处不用再重复，可以指引读者参考需求说明。 3 用例 此处要求系统用用例图表述（UML），对每个用例（正常处理的情况）要有中文叙述。 4 设计概述 4.1 简述 这部分要求突出整个设计所采用的方法（是面向对象设计还是结构化设计）、系统的体系结构（例如客户/服务器结构）以及使用到的相应技术和工具（例如OMT、Rose） 4.2 系统结构设计 这部分要求提供高层系统结构（顶层系统结构、各子系统结构）的描述，使用方框图来显示主要的组件及组件间的交互。最好是把逻辑结构同物理结构分离，对前者进行描述。别忘了说明图中用到的俗语和符号。 4.3 系统界面 各种提供给用户的界面以及外部系统在此处要予以说明。如果在需求规格说明书中已经对用户界面有了叙述，此处不用再重复，可以指引读者参考需求说明。如果系统提供了对其它系统的接口，比如说从其它软件系统导入/导出数据，必须在此说明。 4.4 约束和假定 描述系统设计中最主要的约束，这些是由客户强制要求并在需求说明书写明的。说明系统是如何来适应这些约束的。 另外如果本系统跟其它外部系统交互或者依赖其它外部系统提供一些功能辅助，那么系统可能还受到其它的约束。这种情况下，要求清楚地描述与本系统有交互的软件类型以及这样导致的约束。 实现的语言和平台也会对系统有约束，同样在此予以说明。 对于因选择具体的设计实现而导致对系统的约束，简要地描述你的想法思路，经过怎么样的权衡，为什么要采取这样的设计等等。 5 对象模型 提供整个系统的对象模型，如果模型过大，按照可行的标准把它划分成小块，例如可以把客户端和服务器端的对象模型分开成两个图表述。在其中应该包含所有的系统对象。这些对象都是从理解需求后得到的。要明确哪些应该、哪些不应该被放进图中。所有对象之间的关联必须被确定并且必须指明联系的基数。聚合和继承关系必须清楚地确定下来。每个图必须附有简单的说