软件研发版本管理新规制度.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

2

3

4

5

6

7

8

9

10

11

9．周报管理制度
各项目组每七天向研发部提交周报。周报具体格式以下：

项目周报
汇报名称

所属项目

汇报人

汇报日期

本周工作汇报
1. 任务进度情况

2. 项目成本情况

3. 项目质量情况

4. 用户情况

5. 存在问题和对策

或各个项目组提交最新project 文件。Project文件中包含各任务完成百分比，任务分配人，资源情况。
10．风险管理制度
各项目组每七天向研发部提交风险跟踪表。周报具体格式以下
XYZ项目 风险跟踪表
风险编号
严重性
可能性
风险描述
汇报者
处理者
目前状态
处理方法

Ø 风险严重性：指风险对项目造成危害程度，比如能够划分为5个等级：5－很严重，4－比较严重，3－中等，2－轻度，1－低微。
Ø 风险可能性：指风险发生几率，能够用百分比表示。