模板软件概要设计说明书HLD.docx
《模板软件概要设计说明书HLD.docx》由会员分享，可在线阅读，更多相关《模板软件概要设计说明书HLD.docx（11页珍藏版）》请在冰豆网上搜索。
模板软件概要设计说明书HLD
软件概要设计说明书（）
版本：
文档审批修订记录
文件状态：
[√]草稿
[]正式发布
当前版本：
作者：
审核人：
发布日期：
日期
版本编号
修订号
简要说明
著者
审核者
审核日期
说明：
“简要说明”主要是对修订原因和修订的内容进行简单说明。
简介
目的
范围
软件名称
软件功能
软件应用
概要设计
第层设计描述
软件系统上下文定义：
设计思路（可选）
第一层设计描述
分解描述
依赖性描述
接口描述
第二层设计描述（可选）
模块名称
模块名称
配置和控制（可选）
启动
关闭
表项的创建
表项的删除
表项的更改
数据库（可选）
实体、属性与它们之间的关系
实体（）关系图
函数描述
1简介
1.1目的
这部分要描述文档的目的。
应该指明读者。
1.2范围
1.2.1软件名称
对软件命名
1.2.2软件功能
解释软件产品将完成或不完成的功能（可以直接描述也可以参考相关文档）
1.2.3软件应用
描述软件的应用（可直接描述也可以参考其他软件文档）
2概要设计
2.1第层设计描述
2.1.1软件系统上下文定义：
首先描述本软件系统在实际环境的组网方式（一般用图描述）
描述系统如何与外部实体一道组成功能实体（一般用图描述）
本节还要描述待开发软件系统与外部实体的关系.，可以使用系统架构图、顶层数据流图、事务图等来描述系统结构和交互关系。
所有系统外围实体（在设计规格流程中有定义），这些实体与软件系统发生交互作用或以某种方式影响软件系统，比如，操作系统，驱动程序，硬件，中断，其他软件系统等.
外围实体和本系统相互作用的性质（比如，消息，库调用）和类型（比如，服务，通信服务，系统工具等）。
描述外部实体的特性时要注意该描述一定要有助本软件的设计和描述。
为了本文档内容的完整性，可以采用对于描述相关设计实体文档索引的方式：
如对于操作系统编程手册的索引
2.1.2设计思路（可选）
2.1.2.1设计方法
描述本软件系统所采取的设计方法。
2.1.2.2设计可选方案
对本软件系统的几种设计方案进行分析、比较，并确定所采用的方案
2.1.2.3设计约束
2.1.2.3.1遵循标准
描述本软件所遵循的标准、规范
2.1.2.3.2硬件限制
描述本软件系统实现的硬件限制
2.1.2.3.3技术限制
描述本软件的技术限制
2.1.2.4其他
描述其他有关的设计考虑
2.2第一层设计描述
这里要描述软件系统的总体结构。
总体结构描述可以使用结构图，层次分解图，自然语言。
2.2.1分解描述
2.2.1.1模块子系统分解
本节描述系统中的子系统和模块。
2.2.1.1.1模块子系统描述
按照以下格式描述：
标识：
类型：
目的：
功能列表：
子模块：
如果本模块还要继续划分，列出下属子模块
2.2.1.2并发进程处理分解
本节描述系统中的并发进程。
对于外部实体，从属属性不必描述。
2.2.1.2.1进程描述
按照以下格式描述：
标识：
类型：
目的：
功能列表：
描述本进程中要完成的功能，如功能已经在前面的模块分解中有描述，则重点描述本进程完成了哪些模块的哪些功能。
2.2.1.3数据分解
本节描述系统中的数据结构。
外部数据实体不必描述。
本章节描述本系统中用到的全局数据结构，其中至少包括：
各分解模块直接访问的数据，被各分解模块用来在接口中使用的结构。
描述数据时要注意该数据是否真正为本级模块分解的公用数据。
2.2.1.3.1数据实体描述
按照以下格式描述：
标识：
类型：
目的：
2.2.2依赖性描述
本节描述系统中的子系统，数据结构，模块，进程等设计实体间的关系。
依赖关系描述可以使用结构图（交互）事务图，消息序列图,图。
2.2.2.1运行设计
本章节描述本层设计的各个模块和进程是如何配合完成系统的功能需求.可以用消息序列图,（交互）事务图,结构图等进行描述,可以按照处理过程进行分节描述,要注意的是描述的内容应该涵盖所有文档的功能需求,对于二级设计来讲,就是要涵盖分解对象模块的功能规格
2.2.2.2数据依赖关系
本节描述数据结构间的关系。
依赖关系描述可以使用图。
2.2.3接口描述
本节描述软件系统中设计实体（如子系统，模块，进程）的接口.
接口描述可以使用接口文件，参数表。
对于外部实体只有同被描述软件相关的接口才需描述。
2.2.3.1模块子系统接口
本节描述模块子系统的接口。
2.2.3.1.1模块子系统提供的接口
对于接口函数，可以采用以下形式描述：
接口：
形式：
输入：
输出：
返回：
描述返回什么。
描述：
总体描述该接口实现的目的。
2.2.3.2进程接口
本节描述进程的接口。
2.2.3.2.1进程描述
进程间的接口主要是描述一些共享内存，协议数据，消息等。
按照以下格式描述：
标识：
类型：
目的：
功能列表：
2.3第二层设计描述（可选）
对每个模块重复使用下述的格式（和一层设计一样）。
具体的编写建议参见第一层设计
2.3.1模块名称
2.3.1.1分解描述
2.3.1.1.1模块子系统分解
◆模块子系统描述
◆模块子系统描述
******
2.3.1.1.2并发进程处理分解
◆进程描述
◆进程描述
******
2.3.1.1.3数据分解
◆数据实体描述
◆数据实体描述
******
2.3.1.2依赖性描述
2.3.1.2.1运行设计
2.3.1.2.2数据依赖关系
2.3.1.2.3******
2.3.1.3接口描述
2.3.1.3.1模块子系统接口
◆模块子系统提供的接口
◆模块子系统提供的接口
******
2.3.1.3.2进程接口
◆进程描述
◆进程描述
******
2.3.2模块名称
******
2.4配置和控制（可选）
2.4.1启动
描述启动一个模块的步骤
2.4.2关闭
描述关闭一个模块的步骤
2.4.3表项的创建
创建新表项的动作步骤。
该节的标题可以适当更改
2.4.4表项的删除
删除表项的动作步骤.该节的标题可以适当更改
2.4.5表项的更改
修改表项的动作步骤.该节的标题可以适当更改。
2.5数据库（可选）
2.5.1实体、属性与它们之间的关系
本节列出所有的数据存储类的实体，详细描述实体的内容和并列出全部属性。
对每个属性，详细描述其数据库、数据大小、特定约束。
实体的所有约束与实体间的关系也要注明。
2.5.2实体（）关系图
本节描述关于上节提到的所有实体的图
2.5.3函数描述
本节应按照下列格式进行描述：
标识：
模块名称
类型：
模块类型，如，级设计中的模块，级设计中的进程
功能概述：
简要描述本模块功能，要和概要设计文档中相关模块分解的描述一致。
函数调用关系:
用层次图或结构图的方式描述函数调用关系，如：
图1模块结构图
2.5.3.1函数
;
:
:
:
:
:
:
、，
:
:
:
:
用以下格式描述函数
:
函数名称
:
函数功能、性能等的描述
:
被本函数调用的函数清单
:
被访问的全局变量和数据库表
:
被修改的全局变量和数据库表
:
输入参数说明，包括每个参数的作用、取值说明与参数间关系。
:
对输出参数的说明。
:
函数返回值的说明
:
其它说明
实现：
这里可以使用伪码或流程图
例子:
*该函数重用原来模块中提供的向发消息的函数*
链路号不合法返回，失败
消息类型不正确返回，失败
参数指针为空返回，失败
调用消息申请函数，为临时变量申请消息包空间
申请消息包失败返回，消息申请函数
填写发送模块信息到
调用设备管理的函数，填写目的板的
调用失败
调用，释放的消息包空间
返回，失败
填写目的功能模块号到
填上消息包的具体内容
调用消息发送函数，把消息包发送到给
返回，成功
2.5.3.2函数
参考资料清单：
请罗列本文档所参考的有关参考文献和相关文档，格式如下：
作者＋书名（或杂志、文献、文档）＋出版社（或期号、卷号、公司文档编号）＋出版日期起止页码
例如：
[1]钱学森，《技术》，出版社，（中文书籍格式）
[2]，用户手册，文档室，
升级会员 