研发项目节点验收需求材料提交说明整合Word文件下载.docx
《研发项目节点验收需求材料提交说明整合Word文件下载.docx》由会员分享,可在线阅读,更多相关《研发项目节点验收需求材料提交说明整合Word文件下载.docx(56页珍藏版)》请在冰豆网上搜索。
![研发项目节点验收需求材料提交说明整合Word文件下载.docx](https://file1.bdocx.com/fileroot1/2023-1/7/38a2524b-2883-4dd0-8fe8-66ecd23e6afd/38a2524b-2883-4dd0-8fe8-66ecd23e6afd1.gif)
其中第二部分“服务器端软件部署”和第三部分“相关接口部署说明”中的“3.6客户端下载&
Autopatch部署”为重点填写部分(在模板中用红色标注)
同时请注意:
服务器安检流程通过前,切记不要部署服务器端程序
质量管理中心
版本压力测试说明
其中第一部分服务器物理架构说明,第五部分单组/区服务器标准配置,第六部分性能测试技术接口人为重点填写部分;
另外在第十部分附压力测试工具开发规范(务必阅读并参照)
压力测试工具
项目组自测报告
1、功能自测结果请通过质量管理中心自助测试服务平台进行填写;
2、系统自测结果通过填写自测报告进行提供;
1)OA方面测试版本和测试环境两部分为重点部分(在模板中用红色标注)
2)性能测试方面“
(1)性能测试列表”中CS架构的服务器端性能测试(包括登录过程压力测试、游戏过程压力、登录过程稳定性、游戏过程稳定性)和BS架构的服务器端压力测试为重点填写内容。
同时,注意CB节点验收时服务端应按照实际运营情况的最简架构来部署,即DB、Web、GS、Login等应用服务应按照架构设计分开部署。
(在模板中用红色标注)
公共需求材料
客户端安装程序
原型节点要求提供Demo版本,Alpha节点开始应保证为安装程序文件,而非压缩包形式,如验收版本将对外,则还要保证提交的客户端形式与外放的形式完全统一。
游戏功能列表
列表中的基本内容部分为重点提供内容(在模板中用红色标注)
测试账号
GM命令需求列表
列表中基本的指令功能(在模板中用红色标记),要求项目方必须提供。
由于游戏设计功能多样化,一些游戏特有的功能点测试若有配套相关命令,也请需求方提供。
考虑到不同游戏GM指令的运用方式可能不同,请在提供GM指令列表同时,注明正确的使用方法。
注:
1、前期节点已提交过的验收材料,如没有更新可不需要重复提交
2、验收需求材料包括但不限于以上内容,如合同中有特殊需求请以合同实际情况为准
材料模板与说明
1策划中心
1.1游戏策划案
策划中心游戏性验收策划案要求:
提供材料为合同要求以及符合当前节点进度的详细策划案文档。
提供的策划案必须清楚说明所策划系统或功能的设计目的、逻辑结构及描述。
文档格式以及内容形式不限,根据项目组实际策划规范决定。
2艺术中心
2.1音频设计文档
文档分为3份(或者3个部分)。
“音频风格定位”,“音乐设计内容”及“音效设计内容”。
音频风格定位必须说明游戏的音乐音效风格,“音乐设计内容”及“音效设计内容”包括游戏音频的风格定位,游戏音频的分类,游戏音频具体类别的描述,游戏音频具体类别的制作要求,游戏音频具体类别的实现方式等内容。
文档格式不限,根据项目组的实际规范决定。
2.2声音引擎设计文档
声音引擎设计文档包括游戏声音引擎的功能分类及功能的详细描述,具体的设计参数。
2.3美术设计文档
美术设计文档分为2个部分“美术风格定位”,“游戏设计体系定位”。
“美术风格定位”基本包括:
游戏的质感、色调、光影等
“游戏设计体系定位”基本包括:
角色体系设计、场景体系设计等
项目组可以结合项目实际情况,对项目的美术风格定位做详细的整理和描述。
2.4资源列表文档
资源列表文档是游戏整体开发图量的预估表,资源列表文档包含以下三个部分:
音乐包含以下几个个部分:
“音乐列表”、“音效列表”及“语音列表”(语音部分是具体游戏设计而定)。
每一部分都需要包括所有音频内容的名称,详细描述,使用范围及样本的格式详细要求。
美术包含以下几个个部分:
“原画设计”、“角色制作列表”、“场景制作列表”、“2DUI列表”、“特效”等。
每一部分都需要包括所有开发内容的名称,详细描述,命名格式等详细要求。
3技术中心
3.1客户端概要设计文档<
模板>
<
客户端概要设计文档--模板开始>
1.引言?
1.1背景
1.2定义?
2.框架设计?
2.1运行环境?
2.2游戏框架结构?
(客户端模块框架结构图)
2.3游戏各个系统的设计
分层次地给出各个系统的设计.(可以根据游戏本身进行删减)
2.3.1物品系统
功能名称:
功能名称(功能指游戏中的用户需求功能,也称为系统,譬如聊天功能、坐骑功能、道具功能等)。
功能描述:
功能的基本描述及功能实现方法,包括和其他各模块的调用关系。
涉及界面列表:
(如果没有可不列出)界面列表包括界面基本名称及界面截图
代码清单:
功能对应的代码文件列表
类型说明:
功能涉及的主要类及类的说明,如果没有在这里列出类的成员的说明,需要在程序代码中说明。
实现机制:
主要描述功能的实现机制,涉及服务器通讯的需要写明服务器客户端通讯过程等,最好给出时序图。
完成度说明:
功能和节点对应的完成度说明,完成度可以不必是百分比,可是是具体完成的子功能列表,但是需要写明每节点完成的内容是哪些。
节点版本号
与上版本比较增加的内容
完成情况
2.3.2战斗系统
2.3.3角色系统
2.3.4任务系统
2.3.5技能系统
2.3.6场景系统
2.3.7AI系统
2.3.8渲染系统
2.3.9UI系统
2.3.10声音系统
2.3.11好友系统
2.3.12工会系统
2.3.13商城系统
2.3.14消息系统
3.引擎介绍?
4.其他
其他的一些游戏需要涉及到的内容
4.1文件系统
4.2资源管理
4.3内存管理
4.4寻路
4.5脚本
4.6场景管理以及场景划分
4.7移动同步
4.8客户端系统间的通讯方式
客户端概要设计文档--模板结束>
3.2服务器端整体架构设计<
服务器端整体架构设计--模板开始>
1.框架描述
此处简单描述整体架构的设计思路,主要解决了那些方面的问题。
整体架构图
建议采用uml图描述,尽量不要采用word的框图来描述(给人感觉凌乱、业余)。
//插入图片
根据需要对图示进行概要说明。
服务器功能描述
对每种服务器的功能定义以及在系统中的作用,不同服务器之间的关系,需要明确描述。
2.服务器程序架构
程序整体结构图
描述整个程序的层次结构和模块结构
开发语言
采用什么语言开发,选择的理由。
脚本引擎
如果需要脚本引擎,选择什么脚本引擎,选择的理由?
跨平台支持
是否支持跨平台(主要是指windows/Linux),如何做到跨平台。
国际化支持
是否支持国际化多语言,如何支持?
网络I/O模型
描述该I/O模型的原理及优缺点,为什么要采用这种模型等。
文件I/O模型
如果对文件操作很频繁,则需要描述文件I/O模型,否则不做要求。
线程模型
采用什么线程模型,采用这种模型的好处。
层次结构
整个程序分成几层,各个层次的关系是什么。
模块说明
各个模块的作用及与其他模块的接口。
IPC模型
如果用到IPC(进程间通信),则必须描述采用IPC的类型及原因。
工程和类库目录设置说明
描述那些是基础库目录,那些是功能模块目录,不同server代码放在不同目录。
最好是一个workspace或解决方案,包含多个工程,这样代码管理和编译都比较方便。
3.扩展性和故障均衡方案
扩展性方案
采用什么方案来保证服务器框架的扩展性,包括功能扩展和性能扩展。
比如增加一个新的服务器类型是否困难,性能不够时是否容易扩展。
故障均衡方案
如何对服务器实现容灾处理,尽量减少对玩家的影响。
各种服务器是如何实现负载的动态均衡。
4.关键流程设计
每种流程都必须有流程图,尽量采用uml描述
登录流程
描述登录的整个交互流程,重点描述如何保证整个登录过程的安全性。
小退流程
描述整个小退流程的交互过程。
跳服流程
主要是针对MMO游戏,比如从一个地图服务器跳到另一个地图服务器。
转服流程
比如从一个区的一个组转到另一个组,整个流程是什么,如何保证用户资料完整。
退出流程
用户退出游戏的整个流程描述。
5.数据库方案设计
数据库产品的选择
选择那种DBMS,哪个版本?
选择的理由是什么?
数据库概要设计
需要建几个库,各个库之间的关系是什么?
如何实现跨区数据合并和数据迁移?
数据库备份/恢复方案
如何设计备份策略和计划。
数据库优化方案
数据库优化策略和计划。
6.通信协议设计
协议选择
选择文本还是二进制协议?
通用协议还是私有协议?
协议扩展
如何保证协议的扩展性,满足不同的游戏需求。
协议安全
如何防止数据包的安全,不会被修改和窃取?
如何进行身份认证,防止伪造客户端或服务器
服务器端整体架构设计--模板结束>
3.3工具开发计划<
工具开发计划--模板开始>
1.客户端工具
可根据项目实际情况删减实际需要的工具
1.1场景编辑器
工具简介以及预期开始、完成时间
1.2地图编辑器
1.3特效编辑器
1.4角色编辑器
1.5UI编辑器
1.6MAX导出插件
1.7任务编辑器
2.服务器端工具
2.1自动测试工具
主要批处理测试服务器端的指令
2.2压力机器人
进行压力测试
工具开发计划--模板结束>
3.4版本开发计划
技术中心版本开发计划要求:
希望能够显式的分别列出技术、美术、策划等方面的按节点递增内容,以便各验收中心能清晰的看到需要验收的内容。
文档格式不限,根据项目组实际规范决定。
3.5自动更新机制问卷<
自动更新机制问卷--模板开始>
更新机制
1.使用什么协议(可多选)?
□Http□FTP□BT□其他(请在此注明)
2.支不支持断点续传?
□支持□不支持
3.支不支持多个线程同时下载?
□支持(请注明线程数)□不支持
4.更新服务器采用什么配置?
□IIS□Apache□Server-U□其他(请在此注明)
5.更新服务器地址是域名还是IP?
□域名□IP□动态获取(请在此注明获取方式)
6.是否有更新程序更新自己的处理机制?
(这项必须完成,否则验收不通过)
□有□无
7.更新文件下载完成后更新程序可能会做如下哪些处理(可多选)?
□解压缩文件□拷贝文件或文件夹□运行Exe或Dll
□删除文件或文件夹□修改配置文件□其他操作(请在此注明)
更新逻辑
1.更新文件类型(可多选):
□补丁包(请注明补丁包类型:
Exe/Zip/Rar/7z…)
□单个文件
□二进制差异文件
2.更新方式有(可多选)?
□强制更新(更新完才能进游戏)□非强制更新(更新未完也可进游戏,更新在后台处理)
3.更新与区服的关系(可多选):
□单一更新(所有用户都更新同一内容)□分区更新(可以控制某区用户更新不同的内容)
4.更新程序有没有版本控制?
异常处理
1.下载失败补救机制(可多选):
□无□提示用户□同一地址重试(请注明重试次数)□自动更换地址重新更新
□其他(请注明)
2.处理下载下来的文件时失败的补救机制(可多选):
□无□提示用户□回滚□其他(请注明)
3.更新失败后是否还能启动游戏?
□能□不能□看情况(请注明)
4.用户强制终止更新程序进程会不会引起(可多选)?
□客户端版本混乱□更新程序无法启动□游戏客户端无法启动
□以后都无法更新
简要介绍
1.请在此简要介绍您的更新流程
2.请在此简要介绍您的版本控制
3.请在此简要介绍您的程序更新本身的机制
自动更新机制问卷--模板结束>
3.6代码更新说明文档<
代码更新说明文档--模板开始>
文档更新记录:
日期
增加(修改)内容
负责人
版本
xxxx-xx-xx
xxx
框架设计文档说明
本次节点文档的包括:
xxx设计文档表明状态(新增、修改、未更改)
游戏程序的主框架
可执行程序级
说明2进制级别的程序的关系和依赖等
工程库引用关系
说明解决方案下各个工程的作用以及相互的依赖关系
接口级
最好是类似UML图的接口关系图以及相应的说明
系统框架
主要说明现有的系统的功能以及实现的结构
系统模块名称
模块已有功能
模块新增功能
模块修改功能
针对某一项模块进行框架设计说明,最好有UML图结构
对于上图的说明如下:
1.对于每一个类(结构、接口)简要说明如下:
类/结构/接口名
简要说明
2.各个类和数据结构在源代码中的具体位置见下表:
声明的头文件
3.模块相关的设定文件(主要包括配置文件和其他文件):
文件名
说明
4.系统需要用到的资源文件在客户端的目录:
5.该系统模块对应的设计文档的位置
代码更新说明文档---模板结束>
4技保中心
4.1游戏数据库维护文档<
游戏数据库维护文档--模板开始>
1.
阐述数据库的安装步骤,数据库用户的授权,访问控制,补丁安装,删除有隐患的存储过程等
2、
针对常用的游戏数据库,表,字段说明
3、数据库备份与恢复
阐述数据库备份及恢复的实现方式,检查机制,
4、数据库的日常维护
阐述数据库优化,修复坏表,重建索引,权限修改等实现方式
游戏数据库维护文档--模板结束>
4.2服务器架构及配置<
服务器架构及配置--模板开始>
本文档简要介绍游戏的架构,各个服务的功能及列举开一个新区(组)所需的硬/软件资源列表
1、项目简介
简单介绍游戏项目的类型,如XXX是一款大型多人在线的角色扮演冒险类网络游戏。
游戏主题为强调人与人之间的互助精神,挖掘信念与勇气的意义。
2、服务框架图
以图的方式展示各服务之间的关联及接口
3、各服务简述
简要介绍游戏的各服务及其提供的功能
序号
服务
功能说明
1
Loginsrv
玩家登录验证,向已登录客户端提供各GS的列表,供玩家进一步登录选择;
2
CenterSrv
维护在线玩家列表;
维护并转发各GS状态;
配合LoginSrv向GS提供玩家的验证信息;
3
GameSrv
实现本游戏的其它所有功能与服务;
4
PtoPSrv
实现不同客户端之间的UDP穿透连接,不能穿透者,帮助进行信息转发;
5
Mysql数据库
各项数据(游戏配置信息及玩家信息)的纪录
4、玩家登入步骤介绍
以一个玩家登录游戏的过程说明Login、Center、Gs服务之间的关联,和各个服务在其中的作用。
(如能提供流程图更好)
5、单组/区服务器标准配置
5.1服务器硬软件要求
5.11服务器硬件要求
类别
Cpu
内存
硬盘
网卡
其他
Login
GS
Center
Db
5.12服务器软件环境要求
类型
安装软件
备注
操作系统
数据库
第三方软件(含Linux下的组件)
5.2服务器分区要求
注明服务器的分区信息如C盘,D盘各多大,如各服务要求不同也请在此说明
5.3物理服务器分布
区名
所在IDC
Login数量
Gs数量
Center数量
Db数量
5.4网络需求及网段划分
注明网络带宽,交换机的需求,需安装其他网络设备(防火墙、IDS等)
如有Vlan划分等设置也请在此说明
服务器架构及配置--模板结束>
4.3服务器部署文档<
服务器部署文档--模板开始>
1、服务器前期配置
1.1安装前期包
各项目部按游戏需要调整服务器前期包并安装
Win系统有以下操作
Ø
安装octopod前期包
检查时区
删除默认共享
关闭不用服务
启用Ipsec,指派策略
修改管理员用户名、口令,安装NetSnmp,远程桌面,Gina等
Linux系统有以下操作
升级SSH
安装Zlib
修改sshd侦听端口并重启服务
关掉不需要的服务
启用iptables
安装octopod客户端(安装NetSnmp、远程桌面、Pam等)
1.2Iptables设置
各项目按游戏需要确认需开启的端口在Ipsec中启用,建议先禁止所有端口访问,按游戏需要以“最小化“原则开启端口
setplayer=*
===================================================================================================
@rem清除旧策略
@rem===================================================================================================
@echoWindowsRegistryEditorVersion5.00>
local.reg
@echo.>
>
@echo[-HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Windows\IPSec\Policy\local]>
@echo[HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Windows\IPSec\Policy\local]>
@regedit/slocal.reg
@dellocal.reg
@ipsecpol-wREG-p"
shanda-tuituixia-policy-gs1"
-f*+0-r"
BLOCK-ANY"
-nBLOCK
@rem----------------------------------------------------------------------------------------------------
@rem游戏策略(以下仅加入了玩家访问服务器的规则,其余的请自行添加,要注意分别区分公网地址和内网地址的规则)
-f%player%+0:
9500:
tcp-r"
palyer-pass-gameserver-9500"
-nPASS
9501:
palyer-pass-gameserver-9501"
8000:
palyer-pass-loginserver"
@ipsecpol-x-wREG-p"
pause
2、服务器端软件部署
2.1服务器程序文件及对应配置文件
在以下表格中填入各