软件概要设计说明书范例

1、(完整版软概要设计说明书范例XX 概要设计说明书2018 年 10 月 20拟 制某某某日 期日审 核批 准日 期日 期版权所有 侵权必究(完整版软概要设计说明书范例文档修改录修改日期2017-10版本/状态 V1.0作者某某某修改章节修改描述 初版 V1。0 发17版权所有 侵权必究(完整版软概要设计说明书范例填写说明1。 系结构的定义本体系对整个件系统按如下结构方进行划分：系统子系统模块子模块其中：（1）“统（2)“子统 ）模块子系统划属“系统设计，在系统设计说明书中予描。模块”划分属“概要设计”，在本明书中予以描述。子模块 划分属于“详设计”，在详细设计说明书中予以描述。如系相对简单，可

2、以省略子模块”这一层次。2。 如填写了系统计说明书，则在本说明中略过“系统子系统”划分相关内容（即第 2 章3. 如果系统相简单，不需要做“系统子系统”划分这种情况下，取消填系统设计说明书，只须填写本说明书直接套用“子系统模块”划(即第 3 章）进“系统模块”划分（其中“子系统”一词替换“系统删除本说明书中“系统子系统”划分相关内容（第 章版权所有 侵权必究(完整版软概要设计说明书范例目录1。 简 .11。1。 .背和目的 11。2. .范围 11。3. .术语和缩略 12。 系总体设计 .12。1. . 任务概述 22。1。 .目标 2 需概述 .22.2。 .设概 22。2。1. 总体约束

3、 22.2。2. 系外部接口 22。2。 .设计方案概述 22。3。 .系统架构设 32.3。1. .系的逻辑架构设计 32。3.2。 系统的物理架构设计 42。4. .子系统定义 52。4。 .系统列表 52.4。2。 .子系间关系 63. 子系统 1 设计 .63。1。 .任概述 63.1。1。 .目标 63.1.2 .需求概述 63。2。 .设概述 73.2。1. .总体约束 73.2。2. .子系统外部接口 73。2。 .设计方案概述 83。3. .子统架构计 93。4. . 模块定义 10版权所有 侵权必究(完整版软概要设计说明书范例3.4.1 .模块列表 103。4.2. .模块间

4、关系 3。4.3. .模块描述 114。 非能性需求的实现方案 .126。1。 .性的考虑 136.2. 兼容性的考虑 6.3。 .安全的考虑 6.4. 可移植性的考虑 .136。5。 .集成与测试的考虑 136.6. 可扩展性的考虑 .136。7。 .可靠性的考 146.8. 可维护性的考虑 .145. 难点及解决案 6。 参资料 7. 附录 版权所有 侵权必究(完整版软概要设计说明书范例1.简介1.1.背和的本文档编制的的是说明对软件系统设计考虑，包括软件系的基本处理流 ,软件系统的组织构、模块划分功能分配、接口设计运行设计、数据结构设和出错处理设等，为软件的详细设奠 定基础.1.2.范本

5、文档适用于息推送项目二期产品服务端。术和略 1.3.缩略语英文全名中文解释XMPPThe Extensible Messaging and Protocol可扩展通讯和示协议2.系统总体设计 裁剪说明 如果已编写系统设计说明书 ,或目不做“系统子系统 划分，此章省略 否则内部的各必须按要求填。“系统 子系统”划分. 目的：）计系统整体框:统最高层次的逻辑结构物理结构；2）系统的划分与依赖关定义、子系统之间的接定义、子系统能定义。版权所有 侵权必究1(完整版软概要设计说明书范例2.1.任概目标实现目标和功。需求概述参考“软件需规格说明书。doc.2.2.设概总体约束系统外部接设方案概述建立一套即

6、时讯消息推送的解决方:1)2)云端运用 spring+mina+jgroups 建一个分布式的服务端统，以 XMPP 协提供接口；终端运用 smack 建一个 协的客户端，调用协议口实现消息接收和终端示。版权所有 侵权必究2(完整版软概要设计说明书范例2.3.系统架构计系统的逻辑构设计单 IDC 服务器构图分六层结构：载均衡层、接入层、辑处理层、数据访问层数据层、WEB 层。1)2)3)负载均衡层： TV 终通过域名访问云端， DNS 智能解终的 IP 地让它连接就近的分发服务 器，从分发服器获取接入服务器列，然后断开 XMPP 连接；接入层： 终和接入服务器建立 XMPP 长接，创建会话；逻

7、辑处理层：端协议服务器、推送务(RS计服务器。a)b)c)终端协议服务：终端往接入服务器送协议包，接入服务器发给终端协议务器处理；推送服务器:负责从 MQ 取消息、解析消息条体和消体端在线和离线查询、按各接 入服务器有哪终端登录把消息包分给接入服务器；统计服务器：用 quartz 执定时任务，实现终端每天在线数、终端小在线数、终端每天版权所有 侵权必究34)5)6)(完整版软概要设计说明书范例激活数、终端录次数、消息推送结等统计功能.数据访问层：供数据访问组件，如 Mysql JDBC 接口、jedis 缓存接口。提供第三方推送接口，供第三方云端调的 API,提供单推送(明消息暗消息件(区域+

8、机型）推送、regid 推。数据层： Mongodb 集 ,Mysql 数据库主从 + 读分离，ActiveMQ 消队列， Redis 缓服务 器。WEB 层运营平台、第方推送平台需要整理多 IDC 服务器构图系统的物理构设计版权所有 侵权必究4(完整版软概要设计说明书范例2.4.子统义子系统列表子系统名称（子系统编号功能描述开发方式识由超级管理员运营人员使用，提供1运营平台子系三方管理、基数据、消息管理、运 维、统计、系设置、日志查询等功自行开发23第三方推送接子 系统第三方推送平子 系统能。供第三方云端用的 API，供单点推送（明消息 / 暗消 、条件 区域 + 机 自开发 型推、regi

9、d 推。给第三方使用提供开发者账号注册应用管理、消发布、消息推送结果 自开发 询等功能。云端的一个逻服务器，实现从 取出 消 息 、 解 析 消 息 （ 条 件 体 和 消 息4推送服务器子统 体端在线和离线查询、按各入 自开发服务器有哪些端登录把消息包分发接入服务器云端的后台任系统，运用 quartz 执行定时任务，现终端每天在线数、5后台任务子系端每小时在线、终端每天激活数、 自开发 端登录次数、息推送结果等统计功能为消息盒子终提供云端接口 , 用 XMPP6云端与终端接： 协 .提供获取接入服务器列表、电视 分发服务器、入 终获取唯一标识 userid、以 userid 服务器、终端议

10、登认证、建立会话及连接、推送消 服务器 息反馈消息接收和点情况、终端应用激活上报等议。在云端用 JGroups 技术组建一个集群 ,自行开发7云端集群管理各逻辑服器，实现各成员之间 通讯、成员状反馈、成员列表维护自行开发功能.注：开发方式选：采购、外包、自开发、复用。版权所有 侵权必究5(完整版软概要设计说明书范例子系统间关 裁说明：必填 明子系统之间的调用关、子系统间的接口（消、据结构）以及相关子统之间的协同工 作，可以使用构图、（交互）事务、消息序列图、ER 图描述.3.子系统 设计 裁说明：必填 标题上入系统的编号及名(标识)“系统 模划。 目的：）计子系统整体框架：子系的辑结构；2）块

11、的划分与依赖关系义、模块之间的接口定、模块功能定。3.1.任务概述目标 裁说明：可选 说设计意图目标（总目标分期目标、用范围等。需求概述 裁说明：可选 解释软件产品将完成或不完成的功能可以直接描述也可以考相关文档）版权所有 侵权必究6(完整版软概要设计说明书范例3.2.设计概述3.2.1.1.总体约束开发规范 裁剪说明：可选。如果已填写在 2.2.1.1,此处则略。（1）码约定 规定代码体系、模块之间的接口和命名规则。（2)文件定 规子系统的所有配置、日等文件命名方与格式(3）录约定 规定子系统的目录结构，包括运行目录、源文件目、配置目录、日志目录、数据目录.3.2.1.2.约束 裁说明：可选

12、如果已填写在 2.2。2.2，此处则略。 列对软件设计有重要影响系统内外部约和限制可的约束包括用户环境内存或其它资限制 数据存储和分需求 安全和可靠性求 性能需求测试和可维护需求 子系统外部口 裁说明：如果第 2 章已删除这里必填如果有。 版权所有 侵权必究7(完整版软概要设计说明书范例 描该软件子系统与外部实的接口包括用户界面软接口、硬件接口和通信接. 软件子系统的外部实体，包括:操作系、驱动程序、件、中断、其它软件系统等。 描述待开发软件子系统与外部实体的关系，可以使系统架构图、顶层数据流图、事务图等来描系统结构和交关系，并标示出外部体和本系统相互作用的质（比如：消、库调用）和类型（ 如：

13、服务、通信服务、系统具等）。 详细描述子系统外部接口的参,如：接口名称调用方式传输的数据：哪些数据项数据格式？长度？类型? 频度(实时批理）数据同步机制平台无关性遵循的标准提供的功能前置条件后置条件 3.2.3.方案概述 裁说明：必填如果在“。1 设计概”中已描述过的部,略。 描内容包括:（1）整设计所采用的方法:面对象设计还是结构化设计（2）采的系统架构：例如 MVC 架构、N 层构(3）使用的相技和工:例 OMT、Rose、Visio（4）采的框架技术的形式（5）使的设计模式：层模式、微核式、代理模式等版权所有 侵权必究8(完整版软概要设计说明书范例（6）描资源/内分配，Flash 资源文

14、分配 （7）描哪些模块采用软件复用3.3.子系统架构设计 裁剪说明必 定义子系统的总体逻辑结构，定义模块划分以及模之间的依赖关系。 可以采用分层结构描述如何将子系统分解为模 结构描述可以使用结构图、层次分解图、数据流图并用文字说明相互间的关系 举，绘制结构图如下：具有继承等关的类图的可使用 UML 等工画出关系图，如下：版权所有 侵权必究9(完整版软概要设计说明书范例3.4.模块定义模列表 裁剪说明：必填 列模块时，可以采用表格式（编号可以略）。模块名称（标 模块编号版权所有 侵权必究功能简述10开发方式(完整版软概要设计说明书范例识）注：开发方式选：采购、外包/自开发/复用模块间关系 裁剪说

15、明必 明模块之间调用关系、模块间的口（消息、数据结构）及相关模块之的协同工作，如模 块间时序图，作图，以及系统之间态切换流程.3.4.3.1.模块描述模块 1 标题上加入模块的编号及名称（标识1)功描述 裁剪说明必 说该模块具备什么样的基功能，以及每功能之间的相互关系2）能描述 裁说明：必填 说对模块的性能要求，包精度、时间特和处理速度。3)接描述 裁说明：必填 说明与其它模块的接口，与其它系统或硬件的接口 对接口函数，可以采用以形式描述：接口 1：形式：版权所有 侵权必究11(完整版软概要设计说明书范例输入:输出：返回:描返回什么。描述:总描述该接口实现的目的。 需明确的信息包括：（1)输入

16、列出模块每一输入项的特性包名称、标识、数据的类和格式、数据的有效范围、输入方、 数量和频度、入介质可以是逻辑层的输入项，如：图片源、媒体流、网络数据，也可以是具的物理层面的输入 项，如变量 1、量 2，等等。（2）出项列出模块每一输出项的特性，包括称、标识、数据的类型格式，数据值有效范围、输出方 式、数量和频、输出介质等。4）置描述 裁说明：可选 说该模块所的逻辑位置、物理位，如指明模块放在哪个用服务器或客端的哪个目录、哪 个文件(库，或是数据库内部建立的对象3.4.3.2.模块 2 同 3。3.3.1.4.功能性需的实现方案 裁说明：整章可选 版权所有 侵权必究12(完整版软概要设计说明书范

17、例性能的考虑 如：为满足延时、吞吐量等性,在既定硬件环境约束下所采取设计方案。兼容性的考 对前版本的兼容，以及平升级的考虑。安全的考虑 如作为应用软件，在安全面更多的是考访问控制,包括使用什么的权限管理、分配、证方 案。可移植性的虑 系统果有跨平台的需求，要考虑操作系统、中间、用服务器特性、数据库及三服务移 植。描述如何不同的平台移植,是为可配置的？ 集成与测试考虑 各子系统以及模块以什么后次序进行开、集成（组装）和测,即是采用自底向上法还自顶 向下法.可扩展性的虑 不仅有对系统功能扩展的设计考虑，还要考虑系统性能扩展，即可伸缩性。即考虑： （1）何最低成本地添加新的功能？（2)如何低成本的复制一个新系，并且新旧系可以做成统一?版权所有 侵权必究13(完整版软概要设计说明书范例可靠性的考 对故障检测、故障隔离、故障恢复、容错、冗余、份的设计考虑可维护性的虑 内应涉及：(1）统模块是否可以装配？能模块是否可配置？整个系统是否经参数化？（2）供什么样的维护方式、接口及介面？描述为了系统护而在