软件项目上线规范说明完整版资料Word格式文档下载.docx
- 文档编号:18134418
- 上传时间:2022-12-13
- 格式:DOCX
- 页数:45
- 大小:2.48MB
软件项目上线规范说明完整版资料Word格式文档下载.docx
《软件项目上线规范说明完整版资料Word格式文档下载.docx》由会员分享,可在线阅读,更多相关《软件项目上线规范说明完整版资料Word格式文档下载.docx(45页珍藏版)》请在冰豆网上搜索。
审核项目上线准备工作、安装验证工作,并提出纠正/预防措施。
5工作程序
5.1总则
项目上线一般指软件项目达到合同约定的条件后,经客户确认而进入生产环境或试运行环境的项目阶段。
项目上线应保证:
●保障熟练技术人员的配备;
●对所需的安装环境作出书面报告,提交给用户,使安装时的条件得以具备;
●对安装的结果进行必要的测试;
●客户代表及项目经理对上线的完成进行确认并形成文件备查。
5.2上线准备
项目集成测试(必要时包括系统测试)完成后,项目经理及主要项目成员应与业务部门(或客户)协商制定上线入口准则,并达成一致意见。
项目组根据入口准则的要求进行准备。
项目经理组织项目组人员与业务部门(或客户方)一起进行安装前的准备工作,并完成《用户操作手册》、《安装手册》等上线必备文档的确认工作。
(对于集团内部项目,可以省掉《用户操作手册》、《安装手册》等)
上线前,应就下列方面明确规定项目组和业务部门(或客户)的作用、职责和义务:
●时间进度;
●对用户设施的访问方法(例如保密标记、口令等);
●项目熟练技术人员的配备;
●客户可提供的资源;
●系统安全保障和灾难备份措施。
上线准备工作完成后,应取得业务部门(或客户)允许上线通知,方能进入上线实施工作。
在生产版本正式上线发布前必须对原生产环境版本进行备份,包括应用服务器版本和数据库数据(生产版本备份用于在上线验证环节无法通过,且又在短期内无法快速解决问题时对原生产环境进行恢复,以保证线上业务正常运转)。
5.3运行环境安装
项目经理组织项目组成员在指定的安装现场,实际检查安装环境。
记录安装现场的初始状态,生成《安装初始状态标识》,客户现场代表和安装人员共同确认。
安装人员根据《安装手册》进行实际的安装工作。
安装完成后生成《安装报告》。
内容包括:
基本信息、安装环境、安装列表和系统配置参数、存在问题及解决方案、运行监控计划和人员工作状况。
《安装报告》由项目经理或技术负责人编写,项目经理审核,部门主管批准。
5.4上线验证
若安装后通过试运行验证安装结果,项目组负责通过客户培训、指导客户操作,与客户共同负责系统的试运行。
在试运行过程中,无论是客户提出问题,还是项目成员发现问题,项目经理或项目技术负责人负责收集问题数据,组织协调解决这些问题,并保留质量记录,上报部门主管,以便汇总生成纠正/预防措施记录。
如果问题不能在短时间内解决必须对原生产版本进行恢复,以保证线上业务正常运转,待问题处理完后重新安排计划进行上线。
由安装测试或试运行过程中的问题引起的任何变更须按相应程序文件变更要求执行。
试运行结束后,是否需要《试运行报告》,根据客户对验收工作的具体要求或研发部对项目试运行的具体要求而定,若提交验收申请时需要项目组提交《试运行报告》或事业本部对项目试运行结束有总结要求,则项目经理或项目技术负责人必须根据试运行的情况拟订《试运行报告》,并上报部门主管批准。
5.5上线过程中出现问题的跟踪和处理
●项目经理负责组织处理在上线过程中发现的问题,包括技术问题和业务问题。
●项目经理或项目技术负责人应将问题定性,分析问题原因,落实责任,寻求解决方案。
●负责解决问题的责任人按照计划和进度处理解决存在的问题,对问题的解决与否,应及时反映在《测试问题记录表》中。
●项目经理或项目技术负责人应对问题的处理进行实时监控。
●项目经理以及项目组全体成员应对问题及其解决方案等进行总结,提交部门主管,由部门主管汇总为纠正/预防措施记录,避免同类问题再次出现。
XX概要设计说明书
拟制
某某某
日期
2021年10月20日
审核
批准
文档修改记录
修改日期
版本/状态
作者
修改章节
修改描述
2021-10-17
V1.0
初版V1.0发布
填写说明
1.系统结构的定义
本体系对整个软件系统按如下结构方式进行划分:
系统子系统模块子模块
其中:
(1)“系统子系统”划分属于“系统设计”,在系统设计说明书中予以描述。
(2)“子系统模块”划分属于“概要设计”,在本说明书中予以描述。
(3)“模块子模块”划分属于“详细设计”,在详细设计说明书中予以描述。
如果系统相对简单,可以省略“子模块”这一层次。
2.如果填写了系统设计说明书,则在本说明书中略过“系统子系统”划分的相关内容(即第2章)。
3.如果系统相对简单,不需要做“系统子系统”划分,这种情况下,取消填写系统设计说明书,只须填写本说明书,直接套用“子系统模块”划分(即第3章)进行“系统模块”划分(把其中“子系统”一词替换为“系统”),并删除本说明书中“系统子系统”划分的相关内容(第2章)。
1.简介
1.1.背景和目的
本文档编制的目的是说明对软件系统的设计考虑,包括软件系统的基本处理流程,软件系统的组织结构、模块划分、功能分配、接口设计、运行设计、数据结构设计和出错处理设计等,为软件的详细设计奠定基础。
1.2.范围
本文档适用于消息推送项目二期产品的服务端。
1.3.术语和缩略语
缩略语
英文全名
中文解释
XMPP
TheExtensibleMessagingandPresenceProtocol
可扩展通讯和表示协议
1.
2.
2.系统总体设计
{裁剪说明:
如果已编写系统设计说明书,或项目不做“系统子系统”划分,此章省略;
否则内部的各节必须按要求填写。
}
{“系统──>
子系统”划分。
{目的:
1)设计系统整体框架:
系统最高层次的逻辑结构、物理结构;
2)子系统的划分与依赖关系定义、子系统之间的接口定义、子系统功能定义。
2.1.任务概述
2.1.1.目标
实现目标和功能。
2.1.2.需求概述
参考“软件需求规格说明书”。
2.2.设计概述
2.2.1.总体约束
2.2.2.系统外部接口
2.2.3.设计方案概述
建立一套即时通讯&
消息推送的解决方案:
1)云端运用spring+mina+jgroups建立一个分布式的服务端系统,以XMPP协议提供接口;
2)终端运用smack建立一个XMPP协议的客户端,调用协议接口实现消息接收和终端展示。
2.3.系统架构设计
2.3.1.系统的逻辑架构设计
2.3.1.1.单IDC服务器架构图
分六层结构:
负载均衡层、接入层、逻辑处理层、数据访问层、数据层、WEB层。
1)负载均衡层:
TV终端通过域名访问云端,DNS智能解析终端的IP地址让它连接就近的分发服务器,从分发服务器获取接入服务器列表,然后断开XMPP连接;
2)接入层:
TV终端和接入服务器建立XMPP长连接,创建会话;
3)逻辑处理层:
终端协议服务器、推送服务器(RS)、统计服务器。
a)终端协议服务器:
终端往接入服务器发送协议包,接入服务器转发给终端协议服务器处理;
b)推送服务器:
负责从MQ取出消息、解析消息(条件体和消息体)、终端在线和离线查询、按各接入服务器有哪些终端登录把消息包分发给接入服务器;
c)统计服务器:
运用quartz执行定时任务,实现终端每天在线数、终端每小时在线数、终端每天激活数、终端登录次数、消息推送结果等统计功能。
4)数据访问层:
提供数据访问组件,如MysqlJDBC接口、jedis缓存接口。
提供第三方推送接口,供第三方云端调用的API,提供单点推送(明消息/暗消息)、条件(区域+机型)推送、regid推送。
5)数据层:
Mongodb集群,Mysql数据库(主从+读写分离),ActiveMQ消息队列,Redis缓存服务器。
6)WEB层:
运营平台、第三方推送平台。
2.3.1.2.多IDC服务器架构图
需要整理
2.3.2.系统的物理架构设计
2.4.子系统定义
2.4.1.子系统列表
子系统编号
子系统名称(标识)
功能描述
开发方式
1
运营平台子系统
由超级管理员和运营人员使用,提供第三方管理、基础数据、消息管理、运维、统计、系统设置、日志查询等功能。
自行开发
2
第三方推送接口子系统
供第三方云端调用的API,提供单点推送(明消息/暗消息)、条件(区域+机型)推送、regid推送。
3
第三方推送平台子系统
给第三方使用,提供开发者账号注册、应用管理、消息发布、消息推送结果查询等功能。
4
推送服务器子系统
云端的一个逻辑服务器,实现从MQ取出消息、解析消息(条件体和消息体)、终端在线和离线查询、按各接入服务器有哪些终端登录把消息包分发给接入服务器。
5
后台任务子系统
云端的后台任务系统,运用quartz执行定时任务,实现终端每天在线数、终端每小时在线数、终端每天激活数、终端登录次数、消息推送结果等统计功能。
6
云端与终端接口:
分发服务器、接入服务器、终端协议服务器
为消息盒子终端提供云端接口,用XMPP协议。
提供获取接入服务器列表、电视终端获取唯一标识userid、以userid登录认证、建立会话及长连接、推送消息、反馈消息接收和点击情况、终端应用激活上报等协议。
7
云端集群
在云端用JGroups技术组建一个集群,管理各逻辑服务器,实现各成员之间的通讯、成员状态反馈、成员列表维护等功能。
注:
开发方式可选:
采购、外包、自行开发、复用。
2.4.2.子系统间关系
必填}
{明确子系统之间的调用关系、子系统间的接口(消息、数据结构)以及相关子系统之间的协同工作,可以使用结构图、(交互)事务图、消息序列图、ER图描述。
3.1
3.2
3.3
3.4
3.5
3.6
3.6.1
3.6.2
3.6.3
3.子系统1设计
{标题上加入子系统的编号及名称(标识)}
{“子系统──>
模块”划分。
1)设计子系统整体框架:
子系统的逻辑结构;
2)模块的划分与依赖关系定义、模块之间的接口定义、模块功能定义。
3.
3.1.任务概述
3.1.1.目标
可选}
{说明设计意图目标(总目标、分期目标)、作用范围等。
3.1.2.需求概述
{解释软件产品将完成或不完成的功能(可以直接描述也可以参考相关文档)}
3.2.设计概述
3.2.1.总体约束
3.2.1.1.开发规范
(1)编码约定
{规定代码体系、模块之间的接口和命名规则。
(2)文件约定
{规定子系统的所有配置、日志等文件命名方式与格式。
(3)目录约定
{规定子系统的目录结构,包括运行目录、源文件目录、配置目录、日志目录、数据目录等。
3.2.1.2.XX约束
{列出对软件设计有重要影响的系统内外部约束和限制,可选的约束包括:
•
用户环境
内存或其它资源限制
数据存储和分发需求
安全和可靠性需求
性能需求
测试和可维护性需求}
3.2.2.子系统外部接口
如果第2章已删除,这里必填(如果有)。
{描述该软件子系统与外部实体的接口,包括用户界面、软件接口、硬件接口和通信接口。
{软件子系统的外部实体,包括:
操作系统、驱动程序、硬件、中断、其它软件子系统等。
{描述待开发软件子系统与外部实体的关系,可以使用系统架构图、顶层数据流图、事务图等来描述系统结构和交互关系,并标示出外部实体和本系统相互作用的性质(比如:
消息、库调用)和类型(比如:
OS服务、通信服务、系统工具等)。
{详细描述子系统外部接口的参数,如:
接口名称
•调用方式
•传输的数据:
–哪些数据项?
–数据格式?
–长度?
–类型?
•频度(实时/批处理)
•数据同步机制
•平台无关性
•遵循的标准
•提供的功能
•前置条件
•后置条件
3.2.3.设计方案概述
必填。
如果在“3.1设计概述”中已描述过的部分,可略。
}
{描述内容包括:
(1)整个设计所采用的方法:
面向对象设计还是结构化设计
(2)采用的系统架构:
例如MVC架构、N层架构
(3)使用的相应技术和工具:
例如OMT、Rose、Visio
(4)采用的框架技术的形式
(5)使用的设计模式:
层模式、微内核模式、代理模式等
(6)描述资源/内存分配,Flash资源/文件分配
(7)描述哪些模块采用软件复用
}
3.3.子系统架构设计
{定义子系统的总体逻辑结构,定义模块划分以及模块之间的依赖关系。
{可以采用分层结构描述如何将子系统分解为模块。
{结构描述可以使用结构图、层次分解图、数据流图,并用文字说明相互间的关系。
{举例,绘制结构图如下:
具有继承等关系的类图的可使用UML等工具画出关系图,如下:
3.4.模块定义
3.1.
3.2.
3.3.
3.4.
3.4.1.模块列表
{列举模块时,可以采用表格方式(编号可以省略)。
模块编号
模块名称(标识)
功能简述
采购、外包/自行开发/复用
3.4.2.模块间关系
{明确模块之间的调用关系、模块间的接口(消息、数据结构)以及相关模块之间的协同工作,如模块间时序图,协作图,以及系统之间状态切换流程图。
3.4.3.模块描述
3.4.3.1.模块1
{标题上加入模块的编号及名称(标识)}
1)功能描述
{说明该模块具备什么样的基本功能,以及每个功能之间的相互关系。
2)性能描述
{说明对模块的性能要求,包括精度、时间特性和处理速度。
3)接口描述
{说明与其它模块的接口,与其它系统或硬件的接口。
{对于接口函数,可以采用以下形式描述:
接口1:
形式:
输入:
输出:
返回:
描述返回什么。
描述:
总体描述该接口实现的目的。
{需要明确的信息包括:
(1)输入项
列出模块每一个输入项的特性,包括名称、标识、数据的类型和格式、数据值的有效范围、输入方式、数量和频度、输入介质等;
可以是逻辑层面的输入项,如:
图片资源、媒体流、网络数据等,也可以是具体的物理层面的输入项,如变量1、变量2,等等。
(2)输出项
列出模块每一个输出项的特性,包括名称、标识、数据的类型和格式,数据值的有效范围、输出方式、数量和频度、输出介质等。
4)配置描述
{说明该模块所处的逻辑位置、物理位置,如指明模块放在哪个应用服务器或客户端的哪个目录、哪个文件(库),或是在数据库内部建立的对象。
3.4.3.2.模块2
4.非功能性需求的实现方案
整章可选}
6.1.性能的考虑
{如:
为满足延时、吞吐量等性能,在既定硬件环境约束下所采取的设计方案。
6.2.兼容性的考虑
{对以前版本的兼容,以及平滑升级的考虑。
6.3.安全的考虑
作为应用软件,在安全方面更多的是考虑访问控制,包括使用什么样的权限管理、分配、验证方案。
6.4.可移植性的考虑
{系统如果有跨平台的需求,要考虑操作系统、中间件、应用服务器特性、数据库及第三方服务移植。
描述如何在不同的平台移植,是否为可配置的?
6.5.集成与测试的考虑
{各个子系统以及模块以什么先后次序进行开发、集成(组装)和测试,即是采用自底向上法还是自顶向下法。
6.6.可扩展性的考虑
{不仅有对系统功能扩展的设计考虑,还要考虑系统的性能扩展,即可伸缩性。
即考虑:
(1)如何最低成本地添加新的功能?
(2)如何最低成本的复制一个新系统,并且新旧系统可以做成统一体?
6.7.可靠性的考虑
{对故障检测、故障隔离、故障恢复、容错、冗余、备份的设计考虑。
6.8.可维护性的考虑
{内容应涉及:
(1)系统模块是否可以装配?
功能模块是否可以配置?
整个系统是否已经参数化?
(2)提供什么样的维护方式、接口及介面?
描述为了系统维护而在系统设计中作出的安排,包括在程序中专门安排用于系统的检查与维护的检测点和专用模块,如打印信息的打印规则设计(含打印的形式,关闭和打开打印调试信息的方法等)。
(3)有哪些日常维护需求,并且如何处理?
5.难点及解决方案
{列出可能的疑难问题,并尽可能能给出基本解决思路(包括关键算法、时序、数据结构等)。
可采用表格方式。
难点描述
可采取的解决方案
6.参考资料
{列举编写软件产品概要设计报告时所用到的项目中的其他文档或资料。
7.附录
{在此列出需要补充的相关文档和技术问题。
ACS停车管理软件操作说明
1.1一、停车管理系统功能流程
1.1.11、系统功能概述
本停车场管理系统具有以下的详细特点:
Ø
使用方便快捷。
系统灵敏可靠。
设备安全耐用。
即时收取停车费及其他相关费用。
提前收取长期客户的停车费。
防止拒缴停车费事件发生。
防止收费人员徇私舞弊,和乱收费。
自动化设计,车辆出入快速,提高档次和效率提供优质、安全、自动的泊车服务。
节约管理人员的费用支出,提高工作效率和经济效益。
使用RR-ACS-P2.0全新概念停车场管理系统将充分体现这几个特点。
1.1.22、系统基本功能及特点
※智能卡具有防水、防磁、防静电、无磨损、信息贮存量大、高保密度、一卡多用等特点。
※智能卡操作刷卡无需接触,操作更为方便。
※全中文菜单式操作界面,操作简单、方便。
※完善的财务管理功能,自动形成各种报表。
※临时车全自动出卡,减少人员操作,自动化程度高。
※滚动式LED中文电子显示屏提示,使用户和管理者一目了然。
※出卡系统存卡量不足自动提示。
※车辆入、出全智能逻辑自锁控制系统,严密控制持卡者进、出场的行为符合“一卡一车”的要求。
※具有防抬杆、全卸荷、光电控制、带准确平衡系统的高品质挡车道闸。
※高可靠性和适应性的数字式车辆检测系统。
※压力电波和地感双重防砸车装置可保证车辆在闸杆下停留,闸杆不会落下,或即使杆轻碰到车辆道闸也会停止动作并自动启杆。
1.1.33、系统工作流程
1.1.3.13.1、停车管理软件拓扑图
1.1.3.23.2、拓扑图解释
系统图中,蓝色线代表蓝线两侧设备由网线进行连接并通过TCP通讯,黑色实线代表黑线两侧设备由网线进行连接并通过485通讯,黑色虚线代表黑线两侧设备由485线连接并通过485通讯。
以上拓扑图中,余位显示屏、进入口摄像机、收费显示屏、自助缴费终端等设备需要在连接网线的情况下方能使用,而出入口控制机本身以及其下位设备是可以实现完全脱机使用的。
1.2二、软件操作说明
停车管理软件主要包括两大模块:
停车管理软件和acs通信服务。
Acs通信服务是负责所有设备之间的通信的,在一个系统中,我们只需要安装一个acs通信服务。
加密狗服务内嵌于acs通信服务中,一个加密狗对应一个通信服务。
停车管理软件是停车场管理者对停车场的设备,用户,收费进行统一管理的软件,为了方便用户的使用,停车管理软件可以安装在多个不同电脑上,并支持同时操作。
在运行停车管理软件前,必须先安装acs通信服务程序。
否则无法操作管理软件中的硬件功能。
安装完acs通信服务之后,进入管理软件。
管理软件主要操作功能:
设备查找配置;
收费规则设置;
用户发卡;
车辆进出监控收费;
收费统计报表。
软件的初始设置主要有一下几个步骤:
用户登录-软件参数设置(密钥,收费类型)-参数下载至控制器-卡片初始化-添加用户-下载用户至控制器-系统基本功能正常使用。
1.2.11、登录系统
双击管理软件,弹出如上界面,这是操作员进入系统的门户。
操作员可以通过输入用户名和密码,按“登录”按钮,系统判断用户名密码正确后,允许操作员进入系统。
系统的默认登录用户名为admin,密码为admin,且为最高操作权限。
在进入软件主页面后,可以通过“操作员管理”“角色管理”界面进行对密码以及权限的添加和修改。
本软件支持多语言模式,目前支持中文,英文。
1.2.22、系统主窗体
系统主窗体主要包括5个大的菜单模块:
开始;
设备;
管理;
报表;
系统管理。
1.2.33、系统参数设置
“系统管理-系统参数设置”菜单中,设置密钥参数和写入扇区(支持扇区平移,支持一扇区一密,默认为密钥全“0”,第6扇区);
添加总停车位和已停车位的车位数量;
设置页码大小(该设置为在同一界面下能够同时
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 软件 项目 上线 规范 说明 完整版 资料