软件研发版本管理制度样本.doc

泰豪软件研发版本管理规范v1.0(草案)

研发部
-2-4

目录
文档类别使用对象 3
1．引言 4
1.1目 4
1.2范畴 4
1.3术语定义 4
1.4版序控制记录 5
1.5版本更新记录 5
2．版本管理 5
2．1版本标记办法 5
2．1．1正式版本 5
2．2目录构造 6
2．3文档存储 7
2.3.1 当前版本和历史版本存储 7
2.3.2 开发文档存储 7
2.3.3 源代码存储 7
2.3.4 SQL语句存储 7
2.3.5发行文档存储 7
2．4权限控制管理 8
3．更新管理（版本升级） 8
3.1版本升级原则 8
3.2 新版本发布 9
4．备份管理 9
5．顾客版本管理 10
6．研发部统一管理阶段性版本 10
6.1阶段性版本提交到研发部 10
6.2阶段性版本发布到公司网站上 10
6.3各项目组新版本内部及时备份。 11
7．版本工具使用 11
7.1研发部采用svn配备管理工具 11
8．各项目组提交文档及源码以及规则 11
8.1 各项目组需要提交文档 11
8.2当前所管理产品列表 12
9．周报管理制度 12
10．风险管理制度 13

文档类别使用对象
文档类别

该文档是为泰豪公司提供一种版本管理规范性文献。

使用对象

该文档使用对象为泰豪软件公司研发本部各部门项目经理及版本管理人员，以及其她有关人员。未经允许，该文档不得提供应上述规定对象以外人员阅读或使用。

1．引言
1.1目
本文档是为规范泰豪软件公司研发版本管理而制定。
1.2范畴
本文档为各产品部、事业部版本管理员提供关于版本管理规范有关内容，涉及：
l 版本标记办法
l 软件系统数据存储
l 文档修改控制
l 文档备份制度
1.3术语定义
SVN
Svn是一种开源版本控制系统Subversion简称
文档
一种数据媒体和其上所记录数据。

配备管理
标记和拟定系统中配备项过程，在系统整个生存周期内控制这些项投放和更动，记录并报告配备状态和更动规定，验证配备项完整性和对的性。

软件配备
软件详细形态在某时刻瞬时影像。

配备项
软件配备管理对象称为配备项，如：系统规格阐明书，项目开发筹划，顾客手册，源码。

基线
软件生存周期中各开发阶段末尾标记，它作用是把各阶段工作划分更加明确化，使本来持续工作在这些点上断开，使之便于检查和必定阶段成果。

1.4版序控制记录
版序状态
拟稿
审核
批准
发布日期
1.0
研发部
张洪兴

09/11/18

1.5版本更新记录
*A - 增长 M - 修改 D - 删除
版本/修订版
修改页码
修改记录
修改人
日期
1.0

初始版本

/02

2．版本管理
2．1版本标记办法
为了使工作规范化、统一化，各项目组实行版本标记管理办法分为：正式版本和特殊版本。
2．1．1正式版本
公司在市场上发行正规版本。
以“V”开头，版本号放后。V前面增长项目名称，版本号分3节：主版本号，次版本号和内部版本号，每节之间以小数点（.）间隔。如V2.0.1表达主版本号为2，次版本号为0，内部版本号为1。研发部控制主版本号和次版本号，各项目组控制内部版本号。例如：一体化平台-平阴版v1.1.1 ，一体化平台为产品名称，平阴版为版本名称（平阴为详细项目名称），v1.1.1为主版本号+次版本号+内部版本号。
2．2目录构造
由于各项目组实际状况不同，目录构造很难统一，但为了能更好地管理各项目组文档，建议可将被管理配备项分为三大类：文档类、源码类及安装盘类，这样存储比较清晰，有助于版本管理。至于二级目录是以版本划分，并依照制定目录构造给出文献级目录清单（先给出源程序及文档文献级目录清单，安装盘可后来再执行）：。
现以农电平台1.0目录构造举例如下：

根目录
一级目录
二级目录
三级目录
相应配备项
备注
产品名称
一体化平台
版本号

源码(F:)
核心源码包
jar
源码
存目录前正在修改内容
Class文献
扩展源码包
源码

sql
SQL文献
版本变动阐明

文档(G:)

需求文档
顾客需求记录
版本号在文献名上标记
概要设计文档
总体设计文档
按版本号依次类推
数据库设计
详细设计文档
测试用例
测试记录
版本号在文献名上标记
顾客手册
顾客使用手册

产品阐明书

项目筹划
项目筹划

实行手册
实行手册
月度筹划
月度筹划
安装盘(H:)
REL_SRC
产品盘
或发布文档
SETUP
发布文档

表达正式版本及特殊版本目录按如下原则定义：
（1） 正始版本：以“V”开头，版本号放后，主版本号和次主版本号之间“.”去掉，明细版本号之前加“-”。举例如下：
版本号 目录名
V1.0 V1.0
V1.1 V1.1
V1.0.1 V1.0.1
V1.1.2 V1.1.2
2．3文档存储
2.3.1 当前版本和历史版本存储
对于源码文献，特别增长了一种Current目录，存储当前正在开发与维护源码文献，当前未发布版本所有数据都存储在.....\CURRENT\下。一旦当前版本正式发行，则当前目录被修改为相应历史目录。
历史版本是指已经发行版本，存储在相应版本目录之下，普通不容许改动。
2.3.2 开发文档存储
依照各项目部自己状况，将系统顾客需求记录、总体设计文档、详细设计及数据构造文献、测试记录、顾客手册等放入相应目录下。
2.3.3 源代码存储
源代码涉及如：java，jsp，BMP，ICO等有关文献，是未经编译解决、不能直接交付使用产品文献以及编译产品所需文献；联机协助文献HLP在未生成HLP文献之前DOC，RTF等格式文档也视为源代码。
各子系统当前程序源文献放入相应目录下。对于一种子系统又分各种分子系统状况，应在该目录下分别建立几种相应目录。
2.3.4 SQL语句存储
各子系统SQL文献放入…..\.......\SQL下，对于不同数据库，分别建立不同子目录，如oracle、sysbase、db2等。公共SQL文献直接放入…\SQL下即可，不同数据库特殊SQL分别放入相应子目录下。

2.3.5发行文档存储
发行文档是指产品交付顾客使用所必要文献。涉及：产品可执行文献，顾客使用阐明书，联机协助（HLP）；资源文献（BMP，ICO等），环境配备文献等。
以上文档作为制作发行盘素材，放在RELEASEREL_SRC目录之下，制作好发行盘放在RELEASESETUP目录。
2．4权限控制管理
为保障文档安全性，一致性，以及防止意外修改，必要对不同文档设立不同访问权限。
文档权限类别：只读权限，读写权限。
文档类别：设计文档，源码，发行文档。
顾客类别：开发人员、测试人员、分析设计人员、项目经理、配备管理员、安装盘制作人员、问题及需求管理人员、顾客文档编写人员等。
为了控制不同使用权限，依照规定在服务器上分别建立不同顾客，针对不同配备项所在目录分派不同权限。
为了便于管理，应以表格形式列出人员与管理对象访问关系（顾客权限清单）。
3．更新管理（版本升级）
3.1版本升级原则
版本升级应严格纳入版本管理控制之下。应当谨慎地控制版本升级，保障高版本向下兼容性，或提供严格定义升级办法。
在下面几种状况下，进行版本演化和升级：
1、当产品发生重大修改和改进时，主版本号加1。重大修改和改进涉及：
1） 平台迁移；
2） 开发工具迁移；
3） 体系构造变迁。
2、当产品发生较小改进或修改时，次版本号可以加1。
3、对于改动量比较少，如修改产品错误，可增长内部版本号。内部版本号对顾客来说是不可见，只对项目部内部版本控制有用。
4、记录版本升级过程。每次版本升级，都要填写版本升级登记表，登记表样例如下：

版本升级登记表

版本号
发布日期
修改文献
问题简要描述
发布负责人
批准人
备注

阐明：
版本号： 记录当前发布版本。
发布日期：该版本批准发布日期。
修改文献：版本修改记录文献，普通为版本修改日记。
3.2 新版本发布
新版本发布涉及主版本号和次版本号升级，普通不涉及内部版本号升级。流程如下：
1、 依照项目进展状况，或者依照顾客需要进行发布准备。
2、 在指定目录中，依照本次发布版本号建立相应子目录，将current下所有内容拷贝至新建目录下。
3、 可在新建目录下建立readme.txt，并加入相应内容。
readme.txt文献是记录该版本与上一版本不同，作过哪些改动。格式样例如下：

增长或修改功能
涉及源文献
改动因素

4．备份管理
为了保证文档最大可恢复性，要随时及定期地进行备份工作。
1、 随时备份：
（1） 开发人员每天都要将自已当天修改源文献在本地机器上进行备份。
（2） 开发负责人每天要将所有源文献在本地机备份。
（3） 建议备份采用循环备份。
2、 定期备份
（1） 备份形式为硬盘备份和光盘备份。硬盘备份时，要备份在独立硬盘上；光盘备份时，要将光盘存储在可靠地方。
（2） 备份周期视各产品部、事业部详细状况而定。如果处在开发阶段，每周应对所有源程序项进行备份，普通为每周周五；如果处在其他阶段，依照详细状况而定，但周期不能超过两周。
（3） 备份要由版本管理员负责，备份原则应是保证文档最大可恢复性。
（4） 对于历史版本或某顾客特殊版本，如果无特殊因素不再进行修改话，建议用光盘进行备份，并且应有备份盘阐明文献BACKUP.TXT。该文献应当记录如下内容：本次备份时间，备份内容，执行人。
5．顾客版本管理
当前重要以做项目为主，是依照客户规定开发程序。为了更好地管理源程序，应为每一顾客建立一种顾客版本文献，该文献应包括如下内容：
顾客编号：
顾客名称：
软件版本号：
开始使用时间：
联系人：
联系电话：

顾客程序更改日记样例如下：

更改时间
版本号
修改模块名称
变更因素
变更概述
软件位置
变更人员
备注

阐明：
1） 顾客购买软件时要为该顾客建立一种包括上述内容一种顾客版本文献，并填写关于数据。
2） 顾客进行版本更新时规定填写该文献版本变更记录，用以反映顾客版本变更状况。
6．研发部统一管理阶段性版本
6.1阶段性版本提交到研发部
当各项目组更新了新版本后来，如果次版本号发生变化，各项目组配备管理员经项目经理批准后要把次版本修改内容（提交内容分为修改源码、新文档和安装盘）提交给研发部版本管理人员。
6.2阶段性版本发布到公司网站上
产品新版本发布后来，及时在软件演示环境中进行更新。并且新版本特色和特点要在公司网站上进行发布，描述新版本特色文档要由各项目组进行提供应项目部，经项目部保存后，文档提交给公司网站管理人员进行发布，以便供其她项目组和公司营销人员进行理解。
6.3各项目组新版本内部及时备份。
研发部负责进行所有产品版本管理，但各个项目组也要自己进行备份。
7．版本工具使用
7.1研发部采用svn配备管理工具
研发部采用专门配备管理服务器，此服务器只是专门用于版本管理，普通不用于其她应用，配备管理软件采用svn1.5进行配备管理。

8．各项目组提交文档及源码以及规则
8.1 各项目组需要提交文档
名称
成果描述
立项申请书
写名此项目价值、所需人力资源及费用、可行性分析、成本-效益分析、风险分析
立项评审报告
评审结论、评审建议
软件需求阐明书
目的客户、业务流程、系统中角色、子功能模块简介、质量规定、界面规定
系统设计阐明书
系统约束、开发环境、数据流程图、用例图、模块之间关系图、类函数文献变量等命名规则、系统安全设计阐明、性能分析
数据库设计阐明书
所有表名、表设计、表ER图、生成库sql语句、存储过程等。表及字段命名规则。
顾客界面设计阐明书
系统界面设计阐明、原型图
模块设计阐明书
编程接口、重要数据构造、重要算法
测试用例
用例名称、用例描述、输入值、但愿输出值
缺陷报告
Bug名称、bug状态、bug紧急状况、bug解决人等
测试报告
界面测试报告、性能测试报告
布置阐明书
布置环境阐明、初始化数据、注意事项、数据迁移等
安装和使用手册
安装过程描述、各模块使用手册、FAQ手册
软件源代码
源代码、开发工具、API详细阐明、代码注释、编译后程序
系统维护记录
问题描述、问题解决状况
技术评审报告
评审内容、评审成果、评审人
系统安装程序
打包程序、打包工具、打包完后来安装程序
8.2当前所管理产品列表
序列号
产品名称
应用范畴
所属项目组
产品简介
1
一体化平台
Sg186农电
农电

2
安全性评价系统
电网安全性评价
调度

3
电网调度专业技术安全知识在线调考系统（网省版）
电网
调度

4
电网现场原则化作业系统
电网
调度

5
国调E语言编辑浏览器
电网
调度

6
江西省电力公司生产安全管理系统
电网
调度

7
江西省电力公司电网输电GIS
电网
调度

8
青海一体化OMS项目建设
电网
调度

9
生产管理系统短信平台
电网
调度

10
泰豪EOMP业务基本平台
电网
调度

11
泰豪图形化智能操作票系统
电网
调度

9．周报管理制度
各项目组每周向研发部提交周报。周报详细格式如下：

项目周报
报告名称

所属项目

报告人

报告日期

本周工作报告
1. 任务进度状况

2. 项目成本状况

3. 项目质量状况

4. 客户状况

5. 存在问题和对策

或者各个项目组提交最新project 文献。Project文献中包括各任务完毕比例，任务分派人，资源状况。
10．风险管理制度
各项目组每周向研发部提交风险跟踪表。周报详细格式如下
XYZ项目 风险跟踪表
风险编号
严重性
也许性
风险描述
报告者
解决者
当前状态
解决办法

Ø 风险严重性：指风险对项目导致危害限度，例如可以划分为5个级别：5－很严重，4－比较严重，3－中档，2－轻度，1－低微。
Ø 风险也许性：指风险发生几率，可以用比例表达。