软件项目概要设计说明文书模板文档格式.docx
《软件项目概要设计说明文书模板文档格式.docx》由会员分享,可在线阅读,更多相关《软件项目概要设计说明文书模板文档格式.docx(8页珍藏版)》请在冰豆网上搜索。
版本号
修订描述
修订人
批准人
1引言
1.1概述
{应包括:
a.项目的委托单位、开发单位和主管部门;
b.该软件系统与其他系统的关系。
}
本项目交办方为,承办方为。
1.2目的
{阐明编写概要设计说明书的目的,指明读者对象。
本文档是在用户和开发方对系统进行需求开发,形成软件需求规格说明书后,设计人员分析各个详细需求后,对软件的概要设计。
本文档作为软件概要设计和软件详细设计的重要依据。
软件概要设计人员和软件详细设计人员依此作为工作依据。
1.3读者对象
本系统设计说明书的使用读者为:
业务经理、软件设计、UI设计人员、测试人员。
1.4范围
概要设计要考虑对架构有影响的需求,将系统划分为{子系统一,子系统二},从物理架构,逻辑架构,实现视图,进程视图等四个方面对架构进行描述,定义子系统之间的接口,明确系统依赖的外部接口,说明系统开发准则,选取开发环境,对技术难点进行分析说明。
1.5缩略和术语
Table11缩略语
简称
说明
POI
PositionofInterest
GPS
GlobalPositionSystem
Table12术语
术语
定义
软件配置项
为独立的配置管理而设计的、能满足最终用户要求的一组软件。
TCP
网络传输协议
2参考资料
{参考资料可以是公司内部文档,也可以是外部文档标准或者网站链接.如果网站连接被引用,需要给出链接的URL}
名称
编制单位
编制时间
设计需求规格说明书_Ver8.1_2012_03_18
2017_04_18
3交付需求列表
{列出本次开发要交付的需求,包括新增的需求,从历史版本集成的需求等}
4系统物理架构
4.1系统运行的硬件环境
{使用表格列出系统的硬件环境。
如果客户已经购买了硬件,该处列出即可。
如果是产品,该处给出推荐配置。
列举系统涉及到得第三方厂商的硬件,比如视频设备等}
型号
备注
服务器CPU
志强双核3000
服务器内存
16G
服务器存储
4T
服务器硬盘
320G
服务器网络
千兆网
客户端CPU
P3800
最低
客户端内存
256M
网络
百兆网
共享
4.2系统运行的软件环境
{使用表格列出系统的软件环境。
包括操作系统,数据库等信息}
服务器操作系统
windows2008server
需要提前预研手写控件的支持问题
服务器数据库
Oracle9i
客户端操作系统
Windows2000、xp、Vista、7
客户端浏览器
IE6、IE7
客户端Office
Office2000、xp、2003、2007
4.3系统运行的网络环境
{描述网络带宽,城域、广域、局域,网络稳定性等情况
如,各法院间,是2M城域连接,网络情况较稳定。
每月会出现1-2次断网,同时在使用视频会议时,会限制其他网络应用。
4.4系统部署图
{画出系统部署图}
4.5安装部署说明
{使用表格表格说明哪些程序应部署在哪台计算机上}
5系统逻辑架构
{使用线框图,画出系统的组成架构,要求分清系统层次,尽可能的详细}
5.1子系统一
{简单描述子系统的功能,在系统中所处的位置、作用等。
1.1.1子模块一
1.1.1.1用例
此处要求系统用用例图表述(UML)
1.1.1.2类图
{给出该子模块相关的类图}
1.1.1.3交互图
{给出该子模块相关的交互图}
1.1.2子模块二
1.1.2.1用例
1.1.2.2类图
1.1.2.3交互图
5.2子系统二
6实现视图
{代码目录、包、jar结构、页面目录规则}
7进程视图
{总体描述,具体解决措施可在子系统设计中描述
性能上的考虑,如:
高并发、大数据量等}
{性能瓶颈的预估,应对策略,具体的解决办法要标明参见XX文档的XX章节}
{分析性能对整体框架,技术路线的影响}
8数据库设计
描述数据库的逻辑(表结构)与物理设计(表空间,存储)
9设计约束
描述系统设计中最主要的约束,这些是由客户强制要求并在需求说明书写明的。
说明系统是如何来适应这些约束的。
另外如果本系统跟其它外部系统交互或者依赖其它外部系统提供一些功能辅助,那么系统可能还受到其它的约束。
这种情况下,要求清楚地描述与本系统有交互的软件类型(比如某某某数据库软件,某某某EMail软件)以及这样导致的约束(比如只允许纯文本的Email)。
实现的语言和平台也会对系统有约束,同样在此予以说明。
对于因选择具体的设计实现而导致对系统的约束,简要地描述你的想法思路,经过怎么样的权衡,为什么要采取这样的设计等等。
10内部接口定义
{定义系统内部各子系统之间的接口/协议}
11外部接口
{侧重于与其他系统之间数据交互的描述。
包括数据的格式,使用的协议等等}
{该处主要描述与其他系统间的接口,如:
第三方软件、公司其他相关信息化如办公、办案等系统;
尽可能覆盖到所有的对外接口。
12开发环境说明
包括操作系统,数据库,使用中间件等信息。
目的是约束从代码到可执行程序的过程}
IDE
eclipse3.2
JDK
jdk1.5
中间件
tomcat5.0
13技术难点
{分段列出难点、对难点的分析,以及应对的策略}
技术难点
分析说明
应对策略
节点承载能力
建议的方案对终端进行了负载均衡,使得服务器节点可以复制支持更多终端,但每一个终端的信息都通过服务节点同步到其他n-1个服务器节点,相当于将均衡的后的终端信息汇聚到了单一节点,相当于单一节点承载了所有节点的压力。
采用Proxy模式,减少同步节点的数量,代价是需要增加proxy模式的相关开发
Buffer数据一致性
由于一个节点的数据需要同步到n-1个节点,当节点大于3个时,互相同步的代价相当高,容易造成buffer数据的不一致性
建议节点数不超过3个,增加超时重发机制并但限制重发次数
Buffer容量
由于所用终端的数据汇聚到同一节点,单一buffer节点的容量决定了终端节点的数量
增加缓存容量支持更多终端
14附录
14.1模型文件
{例如UML模型等}
14.2XXXX
{其他相关资源}