软件概要设计说明书范例

纲要设计说明书拟制某某某日期2018年10月20日审查日期同意日期文档改正记录修他日期版本/状态作者改正章节改正描绘2017-10-17某某某第一版公布填写说明系统构造的定义本系统对整个软件系统按以下构造方式进行区分：系统子系统模块子模块此中：（1）“系统子系统”区分属于“系统设计”，在系统设计说明书中予以描绘。（2）“子系统模块”区分属于“纲要设计”，在本说明书中予以描绘。（3）“模块子模块”区分属于“详尽设计”，在详尽设计说明书中予以描绘。假如系统相对简单，能够省略“子模块”这一层次。2.假如填写了系统设计说明书，则在本说明书中掠过“系统子系统”区分的有关内容（即第2章）。3.假如系统相对简单，不需要做“系统子系统”区分，这类状况下，撤消填写系统设计说明书，只须填写本说明书，直接套用“子系统模块”区分（即第3章）进行“系统模块”区分（把此中“子系统”一词替代为“系统”），并删除本说明书中“系统子系统”区分的有关内容（第2章）。目录简介错误!不决义书签。.背景和目的错误!不决义书签。.范围错误!不决义书签。.术语和缩略语错误!不决义书签。系统整体设计错误!不决义书签。.任务概括错误!不决义书签。目标错误!不决义书签。需求概括错误!不决义书签。.设计概括错误!不决义书签。整体拘束错误!不决义书签。系统外面接口错误!不决义书签。设计方案概括错误!不决义书签。.系统架构设计错误!不决义书签。系统的逻辑架构设计错误!不决义书签。系统的物理架构设计错误!不决义书签。.子系统定义错误!不决义书签。子系统列表错误!不决义书签。子系统间关系错误!不决义书签。子系统1设计错误!不决义书签。.任务概括错误!不决义书签。目标错误!不决义书签。需求概括错误!不决义书签。.设计概括错误!不决义书签。整体拘束错误!不决义书签。子系统外面接口错误!不决义书签。设计方案概括错误!不决义书签。.子系统架构设计错误!不决义书签。.模块定义错误!不决义书签。模块列表错误!不决义书签。模块间关系错误!不决义书签。模块描绘错误!不决义书签。4.非功能性需求的实现方案错误!不决义书签。.性能的考虑错误!不决义书签。.兼容性的考虑错误!不决义书签。.安全的考虑错误!不决义书签。.可移植性的考虑错误!不决义书签。.集成与测试的考虑错误!不决义书签。.可扩展性的考虑错误!不决义书签。.靠谱性的考虑错误!不决义书签。.可保护性的考虑错误!不决义书签。5.难点及解决方案错误!不决义书签。参照资料错误!不决义书签。附录错误!不决义书签。简介背景和目的本文档编制的目的是说明对软件系统的设计考虑，包含软件系统的基本办理流程，软件系统的组织构造、模块区分、功能分派、接口设计、运转设计、数据构造设计和犯错办理设计等，为软件的详尽设计确立基础。范围本文档合用于信息推送项目二期产品的服务端。术语和缩略语缩略语英文全名中文解说XMPPTheExtensibleMessagingandPresenceProtocol可扩展通信和表示协议系统整体设计{裁剪说明：假如已编写系统设计说明书，或项目不做“系统子系统”区分，此章省略；不然内部的各节一定按要求填写。}{“系统──>子系统”区分。}{目的：1）设计系统整体框架：系统最高层次的逻辑构造、物理构造；2）子系统的区分与依靠关系定义、子系统之间的接口定义、子系统功能定义。}任务概括目标实现目标和功能。需求概括参照“软件需求规格说明书。设计概括整体拘束系统外面接口设计方案概括成立一套即时通信&信息推送的解决方案：云端运用spring+mina+jgroups成立一个散布式的服务端系统，以XMPP协议供给接口；终端运用smack成立一个XMPP协议的客户端，调用协议接口实现信息接收和终端展现。系统架构设计系统的逻辑架构设计单IDC服务器架构图分六层构造：负载平衡层、接入层、逻辑办理层、数据接见层、数据层、WEB层。负载平衡层：TV终端经过域名接见云端，DNS智能分析终端的IP地点让它连结就近的散发服务器，从分发服务器获得接入服务器列表，而后断开XMPP连结；接入层：TV终端和接入服务器成立XMPP长连结，创立会话；逻辑办理层：终端协议服务器、推送服务器（RS）、统计服务器。终端协议服务器：终端往接入服务器发送协议包，接入服务器转发给终端协议服务器办理；推送服务器：负责从MQ拿出信息、分析信息（条件体和信息体）、终端在线和离线查问、按各接入服务器有哪些终端登录把信息包散发给接入服务器；统计服务器：运用quartz履行准时任务，实现终端每日在线数、终端每小时在线数、终端每日激活数、终端登录次数、信息推送结果等统计功能。数据接见层：供给数据接见组件，如MysqlJDBC接口、jedis缓存接口。供给第三方推送接口，供第三方云端调用的API，供给单点推送（明信息/暗信息）、条件（地区+机型）推送、regid推送。数据层：Mongodb集群，Mysql数据库（主从+读写分别），ActiveMQ信息行列，Redis缓存服务器。WEB层：营运平台、第三方推送平台。多IDC服务器架构图需要整理系统的物理架构设计子系统定义子系统列表子系统编号子系统名称（表记）1营运平台子系统第三方推送接口子系2统第三方推送平台子系3统4推送服务器子系统5后台任务子系统

功能描绘开发方式由超级管理员和营运人员使用，供给第三方管理、基础数据、信息管理、运维、统计、自行开发系统设置、日记查问等功能。供第三方云端调用的API，供给单点推送（明信息/暗信息）、条件（地区+机型）推送、自行开发regid推送。给第三方使用，供给开发者账号注册、应用管理、信息公布、信息推送结果查问等功自行开发能。云端的一个逻辑服务器，实现从MQ拿出消息、分析信息（条件体和信息体）、终端在自行开发线和离线查问、按各接入服务器有哪些终端登录把信息包散发给接入服务器。云端的后台任务系统，运用quartz履行准时任务，实现终端每日在线数、终端每小时在自行开发线数、终端每日激活数、终端登录次数、消息推送结果等统计功能。为信息盒子终端供给云端接口，用XMPP协云端与终端接口：分议。供给获得接入服务器列表、电视终端获6发服务器、接入服务取独一表记userid、以userid登录认证、成立自行开发器、终端协议服务器会话及长连结、推送信息、反应信息接收和点击状况、终端应用激活上报等协议。在云端用JGroups技术组建一个集群，管理各7云端集群逻辑服务器，实现各成员之间的通信、成员自行开发状态反应、成员列表保护等功能。注：开发方式可选：采买、外包、自行开发、复用。子系统间关系{裁剪说明：必填}{明确子系统之间的调用关系、子系统间的接口（信息、数据构造）以及有关子系统之间的共同工作，能够使用构造图、（交互）事务图、信息序列图、ER图描绘。}子系统1设计{裁剪说明：必填}{标题上加入子系统的编号及名称（表记）}{“子系统──>模块”区分。}{目的：1）设计子系统整体框架：子系统的逻辑构造；2）模块的区分与依靠关系定义、模块之间的接口定义、模块功能定义。}任务概括目标{裁剪说明：可选}{说明设计企图目标（总目标、分期目标）、作用范围等。}需求概括{裁剪说明：可选}{解说软件产品将达成或不达成的功能（能够直接描绘也能够参照有关文档）}设计概括整体拘束开发规范{裁剪说明：可选。假如已填写在，此处则略。}（1）编码商定{规定代码系统、模块之间的接口和命名规则。}（2）文件商定{规定子系统的全部配置、日记等文件命名方式与格式。}（3）目录商定{规定子系统的目录构造，包含运转目录、源文件目录、配置目录、日记目录、数据目录等。}ＸＸ拘束{裁剪说明：可选。假如已填写在，此处则略。}{列出对软件设计有重要影响的系统内外面拘束和限制，可选的拘束包含：用户环境内存或其余资源限制数据储存和散发需求安全和靠谱性需求性能需求测试和可保护性需求}子系统外面接口{裁剪说明：假如第2章已删除，这里必填（假如有）。}{描绘该软件子系统与外面实体的接口，包含用户界面、软件接口、硬件接口和通信接口。}{软件子系统的外面实体，包含：操作系统、驱动程序、硬件、中止、其余软件子系统等。}{描绘待开发软件子系统与外面实体的关系，能够使用系统架构图、顶层数据流图、事务图等来描绘系统构造和交互关系，并标示出外面实体和本系统互相作用的性质（比方：信息、库调用）和种类（比方：OS服务、通服气务、系统工具等）。}{详尽描绘子系统外面接口的参数，如：接口名称调用方式传输的数据：–哪些数据项–数据格式–长度–种类频度（及时/批办理）数据同步体制平台没关性按照的标准供给的功能前置条件后置条件}设计方案概括{裁剪说明：必填。假如在“设计概括”中已描绘过的部分，可略。}{描绘内容包含：（1）整个设计所采纳的方法：面向对象设计仍是构造化设计（2）采纳的系统架构：比如MVC架构、N层架构3）使用的相应技术和工具：比如OMT、Rose、Visio4）采纳的框架技术的形式5）使用的设计模式：层模式、微内核模式、代理模式等6）描绘资源/内存分派，Flash资源/文件分派7）描绘哪些模块采纳软件复用}子系统架构设计{裁剪说明：必填

}{定义子系统的整体逻辑构造，定义模块区分以及模块之间的依靠关系。{能够采纳分层构造描绘怎样将子系统分解为模块。}

}{构造描绘能够使用构造图、层次分解图、数据流图，并用文字说明互相间的关系。}{举例，绘制构造图以下：拥有继承等关系的类图的可使用UML等工具画出关系图，以下：}模块定义模块列表{裁剪说明：必填}{列举模块时，能够采纳表格方式（编号能够省略）。}模块编号模块名称（表记）功能简述开发方式注：开发方式可选：采买、外包/自行开发/复用模块间关系{裁剪说明：必填}{明确模块之间的调用关系、模块间的接口（信息、数据构造）以及有关模块之间的共同工作，如模块间时序图，协作图，以及系统之间状态切换流程图。}模块描绘模块1{标题上加入模块的编号及名称（表记）}1）功能描绘{裁剪说明：必填}{说明该模块具备什么样的基本功能，以及每个功能之间的互相关系。}2）性能描绘{裁剪说明：必填}{说明对模块的性能要求，包含精度、时间特征和办理速度。}3）接口描绘{裁剪说明：必填}{说明与其余模块的接口，与其余系统或硬件的接口。}{关于接口函数，能够采纳以下形式描绘：接口1：形式：输入：输出：返回：描绘返回什么。描绘：整体描绘该接口实现的目的。}{需要明确的信息包含：（1）输入项列出模块每一个输入项的特征，包含名称、表记、数据的种类和格式、数据值的有效范围、输入方式、数目和频度、输入介质等；能够是逻辑层面的输入项，如：图片资源、媒体流、网络数据等，也能够是详细的物理层面的输入项，如变量1、变量2，等等。2）输出项列出模块每一个输出项的特征，包含名称、表记、数据的种类和格式，数据值的有效范围、输出方式、数目和频度、输出介质等。}4）配置描绘{裁剪说明：可选}{说明该模块所处的逻辑地点、物理地点，如指明模块放在哪个应用服务器或客户端的哪个目录、哪个文件（库），或是在数据库内部成立的对象。}模块2{同。}非功能性需求的实现方案{裁剪说明：整章可选}性能的考虑{如：为知足延时、吞吐量等性能，在既定硬件环境拘束下所采纳的设计方案。}兼容性的考虑{对从前版本的兼容，以及光滑升级的考虑。}安全的考虑{如：作为应用软件，在安全方面更多的是考虑接见控制，包含使用什么样的权限管理、分派、考证方案。}可移植性的考虑{系统假如有跨平台的需求，要考虑操作系统、中间件、应用服务器特征、数据库及第三方服务移植。描述怎样在不一样的平台移植，能否为可配置的}集成与测试的考虑{各个子系统以及模块以什么先后序次进行开发、集成（组装）和测试，即是采纳自底向上法仍是自顶向下法。}可扩展性的考虑{不单有对系统功能扩展的设计考虑，还要考虑系统的性能扩展，即可伸缩性。即考虑：（1）怎样最低成当地增添新的功能（2）怎样最低成本的复制一个新系统，而且新旧系统能够做成一致体}靠谱性的考虑{对故障检测、故障隔绝、故障恢复、容错、冗余、备份的设计考虑。}可保护性的考虑{内容应波及：1）系统模块能否能够装置功能模块能否能够配置整个系统能否已经参数化2）供给什么样的保护方式、接口及介面