软件概要设计说明书模板.doc

《软件概要设计说明书模板.doc》由会员分享，可在线阅读，更多相关《软件概要设计说明书模板.doc（32页珍藏版）》请在三一文库上搜索。

1、软件概要设计说明书模板模板编号GEN_WEB模板版本V3.0软件概要设计说明书拟制某某某日 期2018 年10 月 20日审 核日 期批日模板编号GEN_WEB模板版本V3.0准期模板编号GEN_WEB模板版本V3.0文档修改记录修改日期版本/ 状态作者修改早节修改描述201710-17V1.0某某某初版V1.0发布模板编号GEN_WEB模板版本V3.0填写说明1. 系统结构的定义本体系对整个软件系统按如下结构方式进行划 分：系统子系统 模块 子模块其中：（1） “系统子系统”划分属于“系统设 计”，在系统设计说明书中予以描述。（2） “子系统模块”划分属于“概要设 计”，在本说明书中予以描述

2、。（3） “模块 子模块”划分属于“详细设 计”，在详细设计说明书中予以描述。如果系统相对 简单，可以省略“子模块”这一层次。2. 如果填写了系统设计说明书，则在本说明书中略过“系统子系统”划分的相关内容（即第 2章）。3. 如果系统相对简单，不需要做“系统 子系统” 划分，这种情况下，取消填写系统设计说明书，只须填写本说明书，直接套用“子系统模块”划分（即第3章）进行“系统 模块”划分（把其中“子系 统”一词替换为“系统”），并删除本说明书中“系统 子系统”划分的相关内容（第2章）。模板编号GEN_WEB模板版本V3.01.简介.1.1.1.2.1.3.0背景和目的 范围 术语和缩略语1任务

3、概述2.1.1.目标12.1.2需求概述122.设计概述22.2.1. 总体约束2122.系统总体设计2.1223.2.3 2.4 3.子系统1设计3.1系统外部接口 设计方案概述 系统架构设计 系统的逻辑架构设计 系统的物理架构设计 子系统定义 子系统列表子系统间关系8 任务概述 目标模板编号GEN_WEB3.2需求概述设计概述3.2.1.总体约束子系统外部接口10设计方案概述 123.3.3.4模块定义 143.4.1模块列表 143.4.2模块间关系 153.4.3模块描述 154. 非功能性需求的实现方案6X 性能的考虑176.2 兼容性的考虑186.3 安全的考虑186.4. 可移植

4、性的考虑186.5. 集成与测试的考虑186.6. 可扩展性的考虑196.7 可靠性的考虑196.8. 可维护性的考虑195.难点及解决方案206.参考资料20乙附录20子系统架构设计 12模板编号GEN_WEB模板版本V3.01. 简介1.1. 背景和目的本文档编制的目的是说明对软件系统的设计考 虑，包括软件系统的基本处理流程，软件系统的组织 结构、模块划分、功能分配、接口设计、运行设计、 数据结构设计和出错处理设计等，为软件的详细设计 奠定基础。1.2. 范围本文档适用于消息推送项目二期产品的服务端。1.3.术语和缩略语缩略 语英文全名中文解释XMPPTheExte nsibleMessa

5、gi ngandPrese nee Protocol可扩展通讯和表示协议模板编号GEN_WEB模板版本V3.02. 系统总体设计裁剪说明：如果已编写系统设计说明书，或项目不 做“系统 子系统”划分，此章省略；否则内部的 各节必须按要求填写。 “系统一一 子系统”划分。目的：1）设计系统整体框架：系统最高层次的逻辑 结构、物理结构；2）子系统的划分与依赖关系定义、子系统 之间的接口定义、子系统功能定义。2.1. 任务概述2.1.1. 目标实现目标和功能。2.1.2. 需求概述参考“软件需求规格说明书模板编号GEN_WEB模板版本V3.022设计概述221 .总体约束系统外部接口 设计方案概述建立

6、一套即时通讯&消息推送的解决方案：1）云端运用 spring+mina+jgroups建立一个分布式的服务端系统，以XMPP协议提供接口；2）终端运用smack建立一个XMPP协议的客 户端，调用协议接口实现消息接收和终端展示。模板编号GEN_WEB模板版本V3.02.3.系统架构设计系统的逻辑架构设计单IDC服务器架构图4 M 络 «.if缚端协饋抵器分六层结构：负载均衡层、接入层、逻辑处理层、 数据访问层、数据层、WEB层1）负载均衡层：TV终端通过域名访问云端， DNS智能解析终端的IP地址让它连接就近的分 发服务器，从 分发服务器获取接入服务器列表， 然后断开XMPP

7、连接；2）接入层：TV终端和接入服务器建立XMPP模板编号GEN_WEB模板版本V3.0长连接，创建会话；3）逻辑处理层：终端协议服务器、推送服务器（RS ）、统计服务器。a）终端协议服务器：终端往接入服务器发送 协议包，接入服务器转发给终端协议服务器处 理；b）推送服务器：负责从MQ取出消息、解析 消息（条件体和消息体）、终端在线和离线查询、 按各接入服务器有哪些终端登录把消息包分发给接入服务器；c）统计服务器：运用quartz执行定时任务， 实现终端每天在线数、终端每小时在线数、终 端每天激活数、终端登录次数、消息推送结果 等统计功能。4）数据访问层：提供数据访问组件，如Mysql JDB

8、C接口、jedis缓存接口。提供第三方推送接 口，供第三方云端调用的API，提供单点推送（明 消息/暗消息）、条件（区域+机型）推送、regid 推送。5）数据层：Mongodb集群,Mysql数据库（主 从+读写分离），ActiveMQ消息队列，Redis缓 存服务器。6）WEB层：运营平台、第三方推送平台。模板编号GEN_WEB模板版本V3.02312 多IDC服务器架构图需要整理2.32系统的物理架构设计lli其器终端恥讥W齐絆 W:-划佃於15接人丿JU务器运甘T台船刃服务淫2.4.子系统定乂子系统列表子系统子系统名功能描述开发方编号称（标识）式1运营平台由超级管理员和运营自行开模板编

9、号GEN_WEB子系统人员使用，提供第三方 管理、基础数据、消息 管理、运维、统计、系 统设置、日志查询等功 能。发2第二方推 送接口子 系统供第三方云端 调用的 API，提供单点推送（明 消息/暗消息）、条件（区 域+机型）推送、regid 推送。自行开发3第二方推 送平台子 系统给第三方使用，提供开 发者账号注册、应用管 理、消息发布、消息推 送结果查询等功能。自行开发4推送服务器子系统云端的一个逻辑服务 器，实现从MQ取出消 息、解析消息（条件体 和消息体）、终端在线 和离线查询、按各接入 服务器有哪些终端登 录把消息包分发给接 入服务器。自行开发某某某有限公司模板编号GEN_WEB模板

10、版本V3.05后台任务 子系统云端的后台任务系统， 运用quartz 执行定时 任务，实现终端每天在 线数、终端每小时在线 数、终端每天激活数、 终端登录次数、消息推 送结果等统计功能。自行开发6云端与终 端接口：分 发服务器、接入服务 器、终端协 议服务器为消息盒子终端提供 云端接口，用XMPP协 议。提供获取接入服务 器列表、电视终端获取 唯一标识 userid、以 userid登录认证、建立 会话及长连接、推送消 息、反馈消息接收和点 击情况、终端应用激活 上报等协议。自行开发7云端集群在云端用JGroups技 术组建一个集群，管理 各逻辑服务器，实现各 成员之间的通讯、成员 状态反馈、

11、成员列表维 护等功能。自行开发模板编号GEN_WEB模板版本V3.0注：开发方式可选：采购、外包、自行开发、复用2.42子系统间关系裁剪说明：必填明确子系统之间的调用关系、子系统间的接口（消息、数据结构）以及相关子系统之间的协同工作， 可以使用结构图、（交互）事务图、消息序列图、ER 图描述。3.子系统1设计裁剪说明：必填标题上加入子系统的编号及名称（标识） “子系统一一 > 模块”划分。目的：1）设计子系统整体框架：子系统的逻辑结构;2）模块的划分与依赖关系定义、模块之间 的接口定义、模块功能定义。3.1. 任务概述3.1.1. 目标裁剪说明：可选说明设计意图目标（总目标、分期目标）、

12、作 用范围等。模板编号GEN_WEB模板版本V3.03.12需求概述裁剪说明：可选解释软件产品将完成或不完成的功能（可以直 接描述也可以参考相关文档）3.2. 设计概述.总体约束开发规范裁剪说明：可选。如果已填写在 ，此处 则略。（1 ）编码约定规定代码体系、模块之间的接口和命名规则。（2 ）文件约定规定子系统的所有配置、日志等文件命名方式 与格式。（3 ）目录约定规定子系统的目录结构，包括运行目录、源文 件目录、配置目录、日志目录、数据目录等。 模板编号GEN_WEB模板版本V3.03212 XX约束裁剪说明：可选。如果已填写在 2222，此处 则略。列出对软件设计有重要影响的系统内外部约束

13、 和限制，可选的约束包括：?用户环境?内存或其它资源限制?数据存储和分发需求?安全和可靠性需求?性能需求?测试和可维护性需求子系统外部接口裁剪说明：如果第2章已删除，这里必填（如 果有）。描述该软件子系统与外部实体的接口，包括用 户界面、软件接口、硬件接口和通信接口。软件子系统的外部实体，包括：操作系统、驱 动程序、硬件、中断、其它软件子系统等。模板编号GEN_WEB模板版本V3.0描述待开发软件子系统与外部实体的关系，可 以使用系统架构图、顶层数据流图、事务图等来描述系统结构和交互关系，并标示出外部实体和本系统相 互作用的性质（比如：消息、库调用）和类型（比如:OS服务、通信服务、系统工具等

14、）。详细描述子系统外部接口的参数，如：?接口名称?调用方式?传输的数据：-哪些数据 项？-数据格式？ -长度？-类型？?频度（实时/批处理）?数据同步机制?平台无关性?遵循的标准?提供的功能?前置条件?后置条件模板编号GEN_WEB模板版本V3.0323.设计方案概述裁剪说明：必填。如果在“ 3.1设计概述”中 已描述过的部分，可略。描述内容包括：（1）整个设计所采用的方法：面向对象设计还 是结构化设计（2）采用的系统架构：例如 MVC架构、N层 架构（3 ）使用的相应技术和工具：例如OMT、Rose、Visio（4）采用的框架技术的形式（5）使用的设计模式：层模式、微内核模式、 代理模式等（

15、6）描述资源/内存分配，Flash资源/文件分 配（7）描述哪些模块采用软件复用3.3.子系统架构设计裁剪说明：必填定义子系统的总体逻辑结构，定义模块划分以模板编号GEN_WEB模板版本V3.0及模块之间的依赖关系。可以采用分层结构描述如何将子系统分解为模 块。结构描述可以使用结构图、层次分解图、数据 流图，并用文字说明相互间的关系。举例，绘制结构图如下:模块2模块4子模块2-12E子模块M子模块3叫:t子模块4轉子模块4七 sJ 7X.y模块1具有继承等关系的类图的可使用 UML等工具画 出关系图，如下：com.tcl. common, cshareLoginActivffycom td.

16、c ommo n. c sh are. widgetBaseT abActivitvMyHameActiwityWeiboCori tentAc tivit y<fMySpte&AetluityPcstWeiboActivitySearclActlvItvLcgou Activitycom t cl. common. cshare. dm模板编号GEN_WEB模板版本V3.011weiboAaindroicI<1com.itcL comma n. c share. util£com tc L com mon- csha re B excepti on3.4.模块定

17、义模块列表裁剪说明：必填列举模块时，可以采用表格方式（编号可以省模板编号GEN_WEB模板版本V3.0略）。模块编 号模块名称（标识）功能简述开发方式注：开发方式可选：采购、外包/自行开发/复用342模块间关系裁剪说明：必填明确模块之间的调用关系、模块间的接口（消 息、数据结构）以及相关模块之间的协同工作，如模 块间时序图，协作图，以及系统之间状态切换流程图。模块描述模块 1标题上加入模块的编号及名称（标识）1 ）功能描述裁剪说明：必填说明该模块具备什么样的基本功能，以及每个 功能之间的相互关系。2 ）性能描述模板编号GEN_WEB模板版本V3.0裁剪说明：必填说明对模块的性能要求，包括精度、

18、时间特性 和处理速度。3 ）接口描述裁剪说明：必填说明与其它模块的接口，与其它系统或硬件的 接口。对于接口函数，可以采用以下形式描述：接口 1 :形式：输入：输出：返回：描述返回什么。描述：总体描述该接口实现的目的。需要明确的信息包括：（1）输入项列出模块每一个输入项的特性，包括名称、标识、 数据的类型和格式、数据值的有效范围、输入方式、 数量和频度、输入介质等；可以是逻辑层面的输入项，如：图片资源、媒体 流、网络数据等，也可以是具体的物理层面的输入项， 如变量1、变量2,等等。模板编号GEN_WEB模板版本V3.0（2）输出项列出模块每一个输出项的特性，包括名称、标识、 数据的类型和格式，数

19、据值的有效范围、输出方式、 数量和频度、输出介质等。4 ）配置描述裁剪说明：可选说明该模块所处的逻辑位置、物理位置，如指 明模块放在哪个应用服务器或客户端的哪个目录、哪个文件（库），或是在数据库内部建立的对象。3432模块2同 333.1。4. 非功能性需求的实现方案裁剪说明：整章可选6.1.性能的考虑女口：为满足延时、吞吐量等性能，在既定硬件 环境约束下所采取的设计方案。模板编号GEN_WEB模板版本V3.062兼容性的考虑对以前版本的兼容，以及平滑升级的考虑。63安全的考虑女口：作为应用软件，在安全方面更多的是考虑 访问控制，包括使用什么样的权限管理、分配、验证 方案。6.4. 可移植性的

20、考虑系统如果有跨平台的需求，要考虑操作系统、 中间件、应用服务器特性、数据库及第三方服务移植' 描述如何在不同的平台移植，是否为可配置的？6.5. 集成与测试的考虑各个子系统以及模块以什么先后次序进行开 发、集成（组装）和测试，即是采用自底向上法还是 自顶向下法。模板编号GEN_WEB模板版本V3.066可扩展性的考虑不仅有对系统功能扩展的设计考虑，还要考虑 系统的性能扩展，即可伸缩性。即考虑：（1）如何最低成本地添加新的功能？（2）如何最低成本的复制一个新系统，并且新 旧系统可以做成统一体？ 6.7.可靠性的考虑对故障检测、故障隔离、故障恢复、容错、冗 余、备份的设计考虑。6.8.可

21、维护性的考虑内容应涉及：（1 ）系统模块是否可以装配？功能模块是否可 以配置？整个系统是否已经参数化？（2 ）提供什么样的维护方式、接口及介面？ 描述为了系统维护而在系统设计中作出的安排， 包括在程序中专门安排用于系统的检查与维护的检测 点和专用模块，如打印信息的打印规则设计（含打印 的形式，关闭和打开打印调试信息的方法等）。（3）有哪些日常维护需求，并且如何处理？ 模板编号GEN_WEB模板版本V3.05. 难点及解决方案裁剪说明：可选列出可能的疑难问题，并尽可能能给出基本解 决思路（包括关键算法、时序、数据结构等）。可采 用表格方式。难点描述可采取的解决方案6. 参考资料裁剪说明：可选列举编写软件产品概要设计报告时所用到的项 目中的其他文档或资料。7附录裁剪说明：可选在此列出需要补充的相关文档和技术问题。