软件概要设计模板.docx
- 文档编号:11324604
- 上传时间:2023-02-26
- 格式:DOCX
- 页数:12
- 大小:21.34KB
软件概要设计模板.docx
《软件概要设计模板.docx》由会员分享,可在线阅读,更多相关《软件概要设计模板.docx(12页珍藏版)》请在冰豆网上搜索。
软件概要设计模板
{子系统名称}
XX软件概要设计说明
拟制:
审核:
会签:
质量保证:
批准:
文档修改记录
版本号
修改内容描述
修改人
日期
备注
目次
1范围
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应遵循的标准或标准
注2:
本节描述需求中规定的或项目组内部制定的设计应遵循的标准、标准。
如有必要可作为本文档的周围单独列出。
3.2接口/协议的约束
注3:
本节描述需求中概念的软件对外的接口和必需遵循的协议。
3.3质量约束
注4:
描述需求规定的或组织规定的软件质量约束,如正确性、健壮性、靠得住性、性能、易用性、清楚性、平安性、可扩展性、兼容性或可移植性。
3.4隐含约束
注5:
描述需求中未明确指出的假设或依托,这些假设或依托对软件的设计将会产生必然的阻碍。
4软件的设计谋略
注6:
本节描述软件的设计谋略,要紧包括:
注7:
设计模式:
描述C/S结构、B/S结构、消息驱动、界面模式
注8:
其它模式:
扩展策略、复用策略、折衷策略。
5逻辑包的划分及设计
注9:
在本节划分逻辑包,并分章节对各逻辑包进行概念。
5.1逻辑包的划分
注10:
画出整个软件的逻辑包视图的组成,要求画到类包(该包全数由类组成,不能再划分为子包)一级。
同时对包的组织作简要介绍。
表4“包”一览表
序号
包的名称
包的标识
层级编号
包的简要描述
表5“类”的一览表
序号
类名
类标识
归属包的标识
父类
层级编号
5.2XX逻辑包设计
注11:
从本节开始,对每一个类包的类图进行说明。
5.2.1包的类图
注12:
画出包的静态类图,简要介绍包中类的组成。
5.2.2类的说明
注13:
本节描述逻辑包中类与UseCase功能/辅助功能的映射关系及类的物理位置。
表6类与UseCase功能/辅助功能的映射关系一览表
序号
类名
类标识
实现功能
对应的UseCase功能/辅助功能
XX包中类的物理位置
序号
类标识
程序库名称
备注
5.3YY逻辑包设计
5.3.1包的类图
5.3.2类的说明
6执行概念
注14:
本节描述各包中类的执行概念。
应包括表示各包中类之间动态关系的图示和说明。
6.1包级执行设计
6.1.1包间的进程图
注15:
画出类包一级的进程图。
依照需要可配以文字说明。
6.1.2包间的序列图
注16:
画出类包间执行序列图,来描述类包间的执行时序和消息等其它关系。
对每一各序列图引用主事件流(MainFlow)和子事件流(Subflow)来讲明正常的执行操纵进程,执行时的中断处置或异样处置可通过备选事件流(AlternativeFlow)来讲明。
6.2XX包执行设计
注17:
以下各末节可依照具体需要进行裁剪,各末节顺序可调整。
6.2.1包内的序列图
注18:
分末节对各个执行重要功能的类包画出它们内部各类或对象之间的序列图。
同时配以适当的文字说明。
6.2.2状态图
注19:
分末节画出其状态对其操纵功能有重要阻碍的类的状态图,同时可描述出该类对象的生命周期。
6.2.3进程转换状态图
注20:
分末节画出执行时进程的动态创建与删除图示。
6.2.4并发处置
注21:
用文字、表格或适合的工具说明并发执行的激活点等动态行为。
7外部接口设计
注22:
本节描述软件的外部接口特性
注23:
只描述对软件需求规格说明(SRS)中的接口需求部份做出修改或增加的接口,其余相同的部份可在此引用;
注24:
若是本节部份内容已在接口设计说明(IDD)中给出,那么在此引用没必要具体描述。
如接口设计说明中没有提供,那么必然要在此处给出。
7.1外部接口示意及标识
注25:
画出接口示用意,为清楚表达出外部实体与软件内部模块的关系,要求画外部接口时直接与模块关联。
表7外部接口一览表
序号
接口名称
接口标识
功能描述
接口类型
优先级别
发送方
接收方
运行状态和方式集合
注26:
接口类型,如:
实时数据传送、数据的存储和检索等;
注27:
当接口有优先级要求时(犹如一个接口有多个接收方),可指出它们之间的优先级别;
注28:
说明作为发送方/接收方的模块时,填写模块名称,以明确表达接话柄体关系。
外部实体可用名字、编号、版本和文档引用等标识。
以下所有外部接口表格中的发送方/接收方均按此方式标识;
注29:
假设该软件在《系统/子系统需求规格说明》中被指明处于多个运行状态和方式,那么应在此给出该接口所对应的运行状态
7.2外部接口描述
注30:
若是所有外部接口的通信方式特性和协议特性相同,可放在前面一路说明;个别外部接口这两方面假设有不同,应在它的特性说明部份另外给出。
此处提供的外部接口各个特性的列表只抽取了该特性的部份重要因素。
编写文档时可参考《系统/子系统需求规格说明》相应部份的详细列表,结合具体情形对它们进行裁剪。
7.2.1通信方式特性
表8外部接口的通信方式特性
通信方法名称
通信方法标识
通信链路/带宽/频率特性
数据传送特性
传输服务
其它特性
适用的接口名称/标识
注31:
数据传送特性,包括传送速度、周期或非周期和传送距离;
注32:
传输效劳,包括:
优先级别和品级;
注33:
其它特性,可包括:
平安性/保密性/私密性方面的考虑,如:
加密、用户辨别、隔离、审计等;流操纵(如:
序列编号缓和冲区分派);消息格式化;路由、寻址、命名约定等内容。
7.2.2协议方式特性
表9外部接口的协议方式特性
协议方法名称
协议方法识符
优先级/层
分组
同步
其它特性
适用的接口名称/标识
注34:
分组,包括:
分段和重组、路由、寻址;
注35:
同步,包括:
连接的成立、保护、终止;
注36:
其它特性,可包括:
合法性检查、错误操纵和恢复进程;状态、标识、任何其它的报告特点等内容。
7.2.3(外部接口的名称和项目唯一标识符)
注37:
从开始编号;
注38:
本节所属的各末节只针对一个外部接口的设计进行详细说明。
7.2.3.1数据元素特性
注39:
说明接话柄体必需提供、存储、发送、访问、接收的单个数据元素的特性。
表10(接口名称)的数据元素特性
数据元素名称
数据元素标识
用途
数据类型
数据长度
范围或精度
发送方
接收方
其它特性
注40:
名称,可包括:
非技术(自然语言)名称;军用标准数据元素名称;技术名称(如代码或数据库中的变量或字段名);缩写名或同义名;
注41:
数据类型,如字母数字、整数等;
注42:
数据长度,包括数据大小和气宇单位;
注43:
其它特性,包括优先级别、时序、频率、容量、序列、其它的约束条件,如:
数据元素是不是可被更新、业务规那么是不是适用;保密性和私密性的约束等。
7.2.3.2数据元素集合体特性
注44:
说明接话柄体必需提供、存储、发送、访问、接收的数据元素集合体的特性。
表11(接口名称)的数据元素集合体特性
数据元素集合体名称
项目唯一标识符
用途
集合体类型
包含的数据元素名称
数据元素序号
发送方
接收方
其它特性
注45:
集合体类型,如记录、消息、文件、数组、显示、报表等。
注46:
数据元素序号,指该数据元素在集合体中的顺序;
注47:
其它特性,包括集合体间的关系,如排序/访问特性;显示和其它输出的视听特性;优先级别、时序、频率、容量、序列、其它的约束条件,如:
数据元素是不是可被更新、业务规那么是不是适用;保密性和私密性的约束等。
7.2.3.3通信方式特性
注48:
假设本接口的通信方式与其它外部接口不同,那么按节的形式在此给出。
不然,本末节应省略。
7.2.3.4协议方式特性
注49:
假设本接口的协议方式与其它外部接口不同,那么按节的形式在此给出。
不然,本末节应省略。
7.2.3.5其它接口特性
注50:
描述接口其它所需的特性,如:
接话柄体的物理兼容性(尺寸、容限、负荷、电压和接插件兼容性等)。
注51:
假设说明某个接口特性时,省略了和节的内容,本末节的编号应为。
8内部接口设计
注52:
参考软件需求规格说明(SRS)中的UseCase结构图,画出接口示用意。
为幸免重复或混乱,本节只要求画出最底一层软件模块之间的接口关系。
可是为了表达出上级的软件模块的接口关系,在描述最底一层软件模块之间接口的发送方和接收方时,须按“较高一级的软件模块名称:
下一级的软件模块名称:
...:
最底层的软件模块名称”的形式来描述,其中“较高一级的软件模块”可上溯到发送方和接收方的上级是同一个软件模块时为止;其它约定合格式参见外部接口部份。
9与上级文档的追溯关系
9.1正向追溯
表12正向追溯表
序号
上级文档被追踪内容的名称/标识
本文档中被追踪内容的名称/标识
备注
注53:
追溯粒度大小应合理
注54:
“上级文档被追踪内容的名称/标识”一栏中可依照项目具体情形填写,如“软件需求的名称/标识”或“界面需求名称/标识”等等。
注55:
“本文档中被追踪内容的名称/标识”一栏中可依照项目具体情形填写,如“包的名称/标识”或“类的标识”等等。
注56:
若是上一级文档由多份文档组成,应标明上一级文档的名称/标识
9.2逆向追溯
表13逆向追溯表
序号
本文档中被追踪内容的名称/标识
上级文档被追踪内容的名称/标识
备注
注57:
追溯粒度大小应合理
注58:
“上级文档被追踪内容的名称/标识”一栏中可依照项目具体情形填写,如“软件需求的名称/标识”或“界面需求名称/标识”等等。
注59:
“本文档中被追踪内容的名称/标识”一栏中可依照项目具体情形填写,如“包的名称/标识”或“类的标识”等等。
注60:
若是上一级文档由多份文档组成,应标明上一级文档的名称/标识
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 软件 概要 设计 模板