软件概要设计说明书讲述

1、XX软件概要设计说明书产品名称密级产品版本XXX概要设计说明书(仅供内部使用)拟制：日期：yyyy/mm/dd审核：日期：yyyy/mm/dd审核：日期：yyyy/mm/dd批准：日期：yyyy/mm/dd版权所有 不得复制目 录1简介31.1目的31.2范围31.2.1软件名称31.2.2软件功能31.2.3软件功能32第0层设计描述32.1引用32.2软件系统上下文定义32.3设计约束32.3.1遵循标准32.3.2硬件限制32.3.3技术限制32.4其他33第一层设计描述33.1设计思路33.1.1设计可选方案33.2系统结构33.2.1系统结构描述33.2.2业务流程说明33.3分解描

2、述33.3.1模块/子系统1描述33.3.2数据设计33.4依赖性描述33.5接口描述33.5.1模块/子系统1的接口描述34第二层设计描述34.1模块1名称34.1.1模块设计描述34.1.2功能实现说明34.1.3接口描述34.1.4设计类定义35数据库设计（可选）35.1实体定义35.1.1分解描述35.1.2内部依赖性描述35.2行为定义35.2.1分解描述35.2.2外部依赖性描述35.2.3内部依赖性描述36组件视图36.1系统运行组件36.2文件组织形式37进程视图3XX软件概要设计说明书关键词：摘 要：缩略语： 缩略语英文全名中文解释1 简介1.1 目的这部分要描述文档的目的。

3、应该指明读者1.2 范围1.2.1 软件名称1.2.2 软件功能解释软件产品将完成或不完成的功能（可以直接描述也可以参考相关文档）1.2.3 软件功能解释软件产品将完成或不完成的功能（可以直接描述也可以参考相关文档）2 第0层设计描述2.1 引用软件的上下文通常在上一个开发阶段输出文档中有详细的描述，这里可以指明引用的文档，不需要重复描述已有的内容。2.2 软件系统上下文定义本节描述待开发软件系统与外部实体的关系，可以使用系统结构图来描述系统结构和交互关系。外部实体属性描述只限于软件设计和描述相关的属性。考虑到描述的完整性，可参考相关软件实体文档，如OS程序员手册。如果与引用文档内容重复，本节

4、可以省略。2.3 设计约束2.3.1 遵循标准描述本软件所遵循的标准、规范2.3.2 硬件限制描述本软件系统实现的硬件限制2.3.3 技术限制描述本软件的技术限制2.4 其他描述其他有关的设计考虑3 第一层设计描述3.1 设计思路3.1.1 设计可选方案对本软件系统的几种设计方案进行分析、比较，并确定所采用的方案。3.2 系统结构3.2.1 系统结构描述这里要描述软件系统的总体结构，可以使用结构图、层次分解图或包图来描述，并应说明系统结构划分的原则（例如，基于标准、协议所规定的体系结构，来自于分析模型的结果，或者基于原有体系结构的结果）。对于使用分析模型的体系结构，应说明分析类的职责及相互关系

5、。3.2.2 业务流程说明描述系统架构模块/分析类之间的动态交互，来说明用例模型中的典型用例场景，以体现系统功能是如何实现的。建议采用Sequence图、Collaboration图等来描述。3.3 分解描述本节描述系统中的子系统和模块。3.3.1 模块/子系统1描述不要直接写“模块/子系统1”，用简短的词语命名模块/子系统。按照以下格式描述：1 简介2 功能列表3.3.2 数据设计本节描述系统中的数据结构。外部数据实体不必描述。1 数据实体1描述按照以下格式描述：标识：类型：目的：3.4 依赖性描述本节描述系统中的子系统，数据结构，模块，进程等设计实体间的关系。依赖关系描述可以使用文字，结构

6、图，（交互）事务图。3.5 接口描述本节描述软件系统中设计实体(如子系统，模块，进程）的接口.接口描述可以使用接口文件，参数表。对于外部实体只有同被描述软件相关的接口才需描述。接口可以是函数调用、事件、消息、信号等。3.5.1 模块/子系统1的接口描述对每个接口按照以下格式描述：名称：（接口名称）说明：（对接口的简短说明）定义:（接口原型定义，说明接口类型及相关参数）4 第二层设计描述L1中定义的每个模块的进一步设计在下面的章节进行描述。对层次比较多的模块，可以增加设计层次，最终要说明对应于最小分解模块的具体设计类（包括其public属性和public方法）。对每个模块重复使用下述的格式。4.

7、1 模块1名称4.1.1 模块设计描述描述模块分解，定义出具体的设计类，用类图来描述其相互关系，并说明所采用的设计模式。4.1.2 功能实现说明使用Sequence图、Collaboration图等来说明这些设计类之间如何交互，实现本模块的典型功能。4.1.3 接口描述描述模块内部的接口关系，如两个设计类间的接口等。4.1.4 设计类定义1 类名应该用实际的类名替换 1.标识说明该类的配置项标识(用于需求跟踪)。 2.简介简单介绍该类的功能。 3.类定义使用类图、伪码描述该类的类定义，需说明该类的所有public属性和public方法。5 数据库设计（可选）本节列出所有的数据存储类的实体(表、

8、存储过程、触发器等)，详细描述实体的内容和并列出全部属性。对每个属性，详细描述其数据库、数据大小、特定约束。实体的所有约束及实体间的关系也要注明。5.1 实体定义5.1.1 分解描述阐述设计思路及约束规则。详细定义每个关键数据表、视图中的各个字段属性、存储要求、完整性约束、功能、注意事项，静态数据表可考虑定义初始配置记录。 5.1.2 内部依赖性描述使用E-R图描述实体间的关联依赖关系，分析对存取空间、性能、完整性的要求。5.2 行为定义5.2.1 分解描述根据功能或其他方式对存储过程/触发器进行归类，便于进一步细化和分解，并说明每类存储过程/触发器主要功能。详细定义每个存储过程(触发器)的功能、输入输出参数、返回值、返回的记录集、依赖的数据表和存储过程，以及一些特殊要求（比如需要启用事务等）。5.2.2 外部依赖性描述描述与其它模块之间的依赖关系。5.2.3 内部依赖性描述描述存储过程间、存储过程和数据表/视图间依赖关系。6 组件视图6.1 系统运行组件使用Component图、deployment图来描述系统的运行组件（EXE文件、DLL等），及其网络部署情况。6.2 文件组织形式描述源代码文件的目录结构（文件夹中各个目录下应存放什么文件）。7 进程视图本节描述将系统分解为轻量级进程（单个控制线程）和重量级进程（成组的轻量级进程）的过程。本