软件概要设计模板.doc

子系统名称XX软件概要设计说明拟 制：审 核：会 签：质量保证：批 准：文档修改记录版本号修改内容描述修改人日期备注目 次1 范围11.1 标识11.2 术语及缩略语11.3 文档概述12 引用文档13 软件设计约束13.1 应遵循的标准或规范13.2 接口/协议的约束23.3 质量约束23.4 隐含约束24 软件的设计策略25 逻辑包的划分及设计25.1 逻辑包的划分25.2 XX逻辑包设计25.3 YY逻辑包设计36 执行概念36.1 包级执行设计36.2 XX包执行设计37 外部接口设计37.1 外部接口示意及标识47.2 外部接口描述68 内部接口设计89 与上级文档的追溯关系89.1 正向追溯89.2 逆向追溯8i1 范围1.1 标识本文档的标题：本文档的标识：本文档的版本号：1.2 术语及缩略语本文档中使用的术语及缩略语详见下表：表 1 本文档使用的术语及缩略语一览表序号术语或缩略语解释备注1.2.3.1.3 文档概述本文档各章节内容说明如下表：表 2 文档概述一览表章节号章 节 名 称内 容 描 述备 注1.2.3.2 引用文档表 3 引用文档一览表序号文档标识文档名称版本号备注1.XX软件系统概述2.3.4.5.3 软件设计约束注1： 本节描述在概要设计阶段制定的设计约束，对“软件需求规格说明”中定义的设计约束可直接引用不必详细描述。3.1 应遵循的标准或规范注1： 本节描述需求中规定的或项目组内部制定的设计应遵循的标准、规范。如有必要可作为本文档的附近单独列出。3.2 接口/协议的约束注1： 本节描述需求中定义的软件对外的接口和必须遵循的协议。3.3 质量约束注1： 描述需求规定的或组织规定的软件质量约束，如正确性、健壮性、可靠性、性能、易用性、清晰性、安全性、可扩展性、兼容性或可移植性。3.4 隐含约束注1： 描述需求中未明确指出的假设或依赖，这些假设或依赖对软件的设计将会产生一定的影响。4 软件的设计策略注1： 本节描述软件的设计策略，主要包括：注2： 设计模式：描述C/S结构、B/S结构、消息驱动、界面模式注3： 其它模式：扩展策略、复用策略、折衷策略。5 逻辑包的划分及设计注1： 在本节划分逻辑包，并分章节对各逻辑包进行定义。5.1 逻辑包的划分注1： 画出整个软件的逻辑包视图的组成，要求画到类包(该包全部由类组成，不能再划分为子包)一级。同时对包的组织作简要介绍。表 4 “包”一览表序号包的名称包的标识层级编号包的简要描述表 5 “类”的一览表序号类名类标识归属包的标识父类层级编号5.2 XX逻辑包设计注1： 从本节开始，对每个类包的类图进行说明。5.2.1 包的类图注1： 画出包的静态类图，简要介绍包中类的组成。5.2.2 类的说明注1： 本节描述逻辑包中类与Use Case功能/辅助功能的映射关系及类的物理位置。表 6 类与Use Case功能/辅助功能的映射关系一览表序号类名类标识实现功能对应的Use Case功能/辅助功能XX包中类的物理位置序号类标识程序库名称备注5.3 YY逻辑包设计5.3.1 包的类图5.3.2 类的说明6 执行概念注1： 本节描述各包中类的执行概念。应包含表示各包中类之间动态关系的图示和说明。6.1 包级执行设计6.1.1 包间的过程图注1： 画出类包一级的过程图。根据需要可配以文字说明。6.1.2 包间的序列图注1： 画出类包间执行序列图，来描述类包间的执行时序以及消息等其它关系。对每一各序列图引用主事件流(Main Flow)以及子事件流(Subflow)来说明正常的执行控制过程，执行时的中断处理或异常处理可通过备选事件流(Alternative Flow)来说明。6.2 XX包执行设计注1： 以下各小节可根据具体需要进行裁剪，各小节顺序可调整。6.2.1 包内的序列图注1： 分小节对各个执行重要功能的类包画出它们内部各类或对象之间的序列图。同时配以适当的文字说明。6.2.2 状态图注1： 分小节画出其状态对其控制功能有重要影响的类的状态图，同时可描述出该类对象的生命周期。6.2.3 进程转换状态图注1： 分小节画出执行时进程的动态创建与删除图示。6.2.4 并发处理注1： 用文字、表格或合适的工具说明并发执行的激活点等动态行为。7 外部接口设计注1： 本节描述软件的外部接口特性注2： 只描述对软件需求规格说明(SRS)中的接口需求部分做出修改或增加的接口，其余相同的部分可在此引用；注3： 如果本节部分内容已在接口设计说明(IDD)中给出，则在此引用不必具体描述。如接口设计说明中没有提供，那么一定要在此处给出。7.1 外部接口示意及标识注1： 画出接口示意图，为清楚表达出外部实体与软件内部模块的关系，要求画外部接口时直接与模块关联。5表 7 外部接口一览表序号接口名称接口标识功能描述接口类型优先级别发送方接收方运行状态和方式集合注2： 接口类型，如：实时数据传送、数据的存储和检索等；注3： 当接口有优先级要求时(如同一个接口有多个接收方)，可指出它们之间的优先级别；注4： 说明作为发送方/接收方的模块时，填写模块名称，以明确表达接口实体关系。外部实体可用名字、编号、版本和文档引用等标识。以下所有外部接口表格中的发送方/接收方均按此方式标识；注5： 若该软件在系统/子系统需求规格说明中被指明处于多个运行状态和方式，则应在此给出该接口所对应的运行状态软件需求规格说明7.2 外部接口描述注1： 如果所有外部接口的通信方法特性以及协议特性相同，可放在前面一起说明；个别外部接口这两方面若有差别，应在它的特性说明部分另外给出。此处提供的外部接口各个特性的列表只抽取了该特性的部分重要因素。编写文档时可参考系统/子系统需求规格说明相应部分的详细列表，结合具体情况对它们进行裁剪。7.2.1 通信方法特性表 8 外部接口的通信方法特性通信方法名称通信方法标识通信链路/带宽/频率特性数据传送特性传输服务其它特性适用的接口名称/标识 注1： 数据传送特性，包括传送速率、周期或非周期以及传送间隔；注2： 传输服务，包括：优先级别和等级；注3： 其它特性，可包括：安全性/保密性/私密性方面的考虑，如：加密、用户鉴别、隔离、审计等；流控制（如：序列编号和缓冲区分配）；消息格式化；路由、寻址、命名约定等内容。7.2.2 协议方法特性表 9 外部接口的协议方法特性协议方法名称协议方法识符优先级/层分组同步其它特性适用的接口名称/标识注1： 分组，包括：分段和重组、路由、寻址；注2： 同步，包括：连接的建立、维护、终止；注3： 其它特性，可包括：合法性检查、错误控制和恢复过程；状态、标识、任何其它的报告特征等内容。7.2.3 (外部接口的名称和项目唯一标识符)注1： 从7.2.3开始编号；注2： 本节所属的各小节只针对一个外部接口的设计进行详细说明。7.2.3.1 数据元素特性注1： 说明接口实体必须提供、存储、发送、访问、接收的单个数据元素的特性。表 10 (接口名称)的数据元素特性数据元素名称数据元素标识用途数据类型数据长度范围或精度发送方接收方其它特性 注1： 名称，可包括：非技术（自然语言）名称；军用标准数据元素名称；技术名称（如代码或数据库中的变量或字段名）；缩写名或同义名；注2： 数据类型，如字母数字、整数等；注3： 数据长度，包括数据大小和度量单位；注4： 其它特性，包括优先级别、时序、频率、容量、序列、其它的约束条件，如：数据元素是否可被更新、业务规则是否适用；保密性和私密性的约束等。7.2.3.2 数据元素集合体特性注1： 说明接口实体必须提供、存储、发送、访问、接收的数据元素集合体的特性。表 11 (接口名称)的数据元素集合体特性数据元素集合体名称项目唯一标识符用途集合体类型包含的数据元素名称数据元素序号发送方接收方其它特性注2： 集合体类型，如记录、消息、文件、数组、显示、报表等。注3： 数据元素序号，指该数据元素在集合体中的顺序；注4： 其它特性，包括集合体间的关系，如排序/访问特性；显示和其它输出的视听特性；优先级别、时序、频率、容量、序列、其它的约束条件，如：数据元素是否可被更新、业务规则是否适用；保密性和私密性的约束等。7.2.3.3 通信方法特性注1： 若本接口的通信方法与其它外部接口不同，则按7.2.1节的形式在此给出。否则，本小节应省略。7.2.3.4 协议方法特性注1： 若本接口的协议方法与其它外部接口不同，则按7.2.2节的形式在此给出。否则，本小节应省略。7.2.3.5 其它接口特性注1： 描述接口其它所需的特性，如：接口实体的物理兼容性（尺寸、容限、负荷、电压和接插件兼容性等）。注2： 若说明某个接口特性时，省略了7.2.3.3和7.2.3.4节的内容，本小节的编号应为7.2.3.3。8 内部接口设计注1： 参考软件需求规格说明(SRS)中的Use Case结构图，画出接口示意图。为避免重复或混乱，本节只要求画出最底一层软件模块之间的接口关系。但是为了表达出上级的软件模块的接口关系，在描述最底一层软件模块之间接口的发送方和接收方时，须按“较高一级的软件模块名称：下一级的软件模块名称：.：最底层的软件模块名称”的形式来描述，其中“较高一级的软件模块”可上溯到发送方和接收方的上级是同一个软件模块时为止；其它约定及格式参见外部接口部分。9 与上级文档的追溯关系9.1 正向追溯表 12 正向追溯表序号上级文档被追踪内容的名称/标识本文档中被追踪内容的名称/标识备注注1： 追溯粒度大小应合理注2： “上级文档被追踪内容的名称/标识”一栏中可根据项目具体情况填写，如“软件需求的名称/标识”或“界面需求名称/标识”等等。注3： “本文档中被追踪内容的名称/标识”一栏中可根据项目具体情况填写，如“包的名称/标识”或“类的标识”等等。注4： 如果上一级文档由多份文档组成，应标明上一级文档的名称/标识9.2