软件版本管理文档

《软件版本管理文档》由会员分享，可在线阅读，更多相关《软件版本管理文档（15页珍藏版）》请在金锄头文库上搜索。

1、软件版本管理文档口标准化文件发布号：（9312-EUATWW-MWUB-WUNN-INNUL-DQQTY-软件版本管理规范文档编号：编制：杨忠林审核:目录批准:1引言 错误 ! 未定义书签。目的 错误!未定义书签。范围 错误!未定义书签。术语定义 错误!未定义书签。版序控制记录 错误!未定义书签。版本更新记录 错误!未定义书签。2版本管理 错误!未定义书签。流程图 错误!未定义书签。版本命名 错误!未定义书签。外部版本命名说明 错误!未定义书签。内部版本命名说明 错误!未定义书签。内外部版本的关系 错误!未定义书签。版本升级 错误!未定义书签。版本升级原则错误!未定义书签新版本的发布错误!未定

2、义书签目录结构 错误!未定义书签。文档的存放 错误!未定义书签。文本文件的存放错误!未定义书签源代码的存放错误!未定义书签发行文档的存放错误!未定义书签权限控制管理 错误!未定义书签。3备份管理 错误!未定义书签。源文件备份 错误!未定义书签。库文件备份 错误!未定义书签。4用户版本管理 错误!未定义书签。5版本工具的使用 错误 ! 未定义书签。配置管理工具 错误!未定义书签。SVN 的使用 错误!未定义书签。常用命令错误!未定义书签简单操作错误!未定义书签版本分支管理错误!未定义书签。1引言1.1目的本文档是为规范XXXX科技有限公司软件版本管理而制定的。12范围本文档为系统软件开发部版本管

3、理员提供有关版本管理规范的相关内容，包括:版本标识方法软件系统数据的存放文档的修改控制文档的备份制度13术语定义SVNSVN是一个开源的版本控制系统Subversion的简称文档一种数据媒体和其上所记录的数据。配置管理标识和确定系统中配置项的过程，在系统整个生存周期内控制这些项的投放和更 动，记录并报告配置的状态和更动要求，验证配置项的完整性和正确性。软件配置软件的具体形态在某时刻的瞬时影像。配置项软件配置管理的对象称为配置项，如：系统规格说明书，项目开发计划，用户手册, 源码。基线软件生存周期中各开发阶段末尾的标记，它的作用是把各阶段工作的划分更加明确 化，使本来连续的工作在这些点上断开，使

4、之便于检验和肯定阶段成果。1.4 版序控制记录版序状 态拟稿审核批准发布日期系统软件开发部1.5 版本更新记录*A - 增加 M - 修改 D - 删除版本/修订版修改页 码修改记录修改人日期初始版本2 版本管理2.1 流程图2.1.1文档归档流程2.1.2文档变更流程变更申请人评审人员文档编写人员配置管理员2.1.3代码归档流程2.1.4代码变更流程变更申请人评审人员开发人员测试人员配置管理员流程说明：1、开发人员完成所负责模块的代码编写任务后，提交到项目经理处2、项目经理向测试部门提交测试任务3、配置管理员准备测试所需的环境4、测试人员开展测试并实时提交 BUG5、开发人员处理测试过程中所

5、出现的BUG,并提交给测试人员进行回归测试，直至 BUG 被关闭6、测试基本完成后，测试人员提交测试报告7、项目情况根据实际情况决定是否发布新的版本8、配置管理员与各相关人员经讨论后确定好新版本各项信息9、配置管理员发布新版本2.2 软件版本命名外部版本命名说明公司对外销售、宣传、所使用的两位版本号，也正是软件产品登记证所使用的版本号。例： 内部版本命名说明内部版本号由四部分组成，第一个 1 为主版本号，第二个 1 为子版本号，第三个 1 为阶段版本号，第四部分为日期版本号加希腊字母版本号，希腊字母版本号共有5 种，分别为：Base、Alpha、Beta、RC、Release。例如：021_B

6、eta。对于小项目或子系 统而言，可简化为主版本号.次版本号.修订版本号，如 。*主版本号：当功能模块有较大的变动，比如增加多个模块或者整体架构发生变 化。此版本号由项目决定是否修改。*子版本号：当功能有一定的增加或变化，比如增加了对权限控制、增加自定义视 图等功能。此版本号由项目决定是否修改。*阶段版本号：一般是 Bug 修复或是一些小的变动，要经常发布修订版，时间间隔 不限，修复一个严重的 Bug 即可发布一个修订版。此版本号由项目经理决定是否修 改。*日期版本号用于记录修改项目的当前日期，每天对项目的修改都需要更改日期版 本号。此版本号由开发人员决定是否修改。* Base 版: 刚出型；

7、* Alpha 版:此版本表示该软件在此阶段主要是以实现软件功能为主，通常只在软件 开发者内部交流，一般而言，该版本软件的 Bug 较多，需要继续修改。* Beta版:该版本相对于a版已有了很大的改进，消除了严重的错误，但还是存在 着一些缺陷，需要经过多次测试来进一步消除，此版本主要的修改对像是软件的 UI。* RC版:该版本已经相当成熟了，基本上不存在导致错误的BUG，与即将发行的正 式版相差无几。* Release 版: 该版本意味“最终版本”，在前面版本的一系列测试版之后，终归会有 一个正式版本，是最终交付用户使用的一个版本。该版本有时也称为标准版。一般情 况下，Release不会以单词

8、形式出现在软件封面上，取而代之的是符号(R)。 内外部版本的关系外部版本和内容版本两项没有绝对关系，只有字典对应关系。 软件领用登记表在领导用，必须填外部版本和内容版本两项，都必须填写。例：外部版本内部版本序列号客户领用人备注还原影像 存档与通 讯系统V2.2.1版本升级原则版本升级应严格纳入版本管理的控制之下。应当谨慎地控制版本的升级，保障高版 本的向下兼容性，或提供严格定义的升级方法。在下面几种情况下，进行版本演化和升级：1、当产品发生重大修改和改进时，主版本号加 1。重大修改和改进包括：1)平台迁移；2)开发工具的迁移3)体系结构的变迁。2、当产品发生较小的改进或修改时，次版本号可以加

9、1。3、对于改动量比较少的，如修改产品的错误，可升级修订版本号。4、记录版本升级过程。每次版本升级，都要填写版本升级记录表，记录表样例如 下：版本升级记录表主版 本子系统名 称子系统版 本发布日 期功能变更描述发布责任人批准 人备注说明：版本号： 记录当前发布的版本。 发布日期：该版本批准发布的日期。 修改文件：版本修改记录文件，一般为版本修改日志。2.2.2新版本的发布新版本的发布包括主版本号和次版本号的升级，一般不包括内部版本号的升级。流 程如下：1、根据项目进展情况，或者根据用户需要进行发布准备。2、将发布所需文件进行打包，放在指定目录中，给目录加上标签Tag,标签 中包含将要发布的版本

10、信息。3、同样对源码文件也要加上与版本信息相关的标签 Tag。标签 Tag 命名规则如下： 组成：模块首字母+下划线+文件类型+下划线+主版本号+次版本号+内部版本号+时 间(+下划线+合并标记)样例：qzcj_src_1_0_0_110923, qzcj表示采集模块的首字母，src表示源码，1_0_0 表示将要发布的版本号，合并标记可省略，只在有合并操作时注明，其中 合并前的标记为 mbe， 合并后的标记为 maf。2.3 目录结构但为了能更好地管理各项目组的文档，建议可将被管理的配置项分为三大类：文档 类、源码类及安装盘类，这样存放比较清晰，有利于版本管理，现将目录结构整理如 下：根目录一

11、级目 录二级目录对应配置项备注resp源码code前置采集源码后台计算源码业务应用源码数据库SQL文件业务支撑公用开发包文档doc需求文档立项报告、需求分析、 需求记录设计文档软件架构、总体设计、 概要设计、详细设计、 界面设计数据库文档数据字典、数据库拾 建、备份还原方案、PDM设计测试文档测试计划、测试用例、 测试报告用户文档用户手册、产品说明计划文档项目计划、年度月度计 划外部接口文 档标准规范发布文 件SETUPreleaserar文件发布文档二级目录中的版本指一些特殊的版本，不影响基线版本。2.4 文档的存放2.4.1文本文件的存放根据各项目部自己的情况，将系统用户需求记录、总体设计

12、文档、详细设计及数据 结构文件、测试记录、用户手册等放入SVN仓库doc目录相应的子目录下。2.4.2源代码的存放源代码包括如：h,cs, BMP，ICO等相关文件，是未经编译处理的、不能直接交付 使用的产品文件以及编译产品所需的文件；联机帮助文件 HLP 在未生成 HLP 文件之前 的 DOC， RTF 等格式的文档也视为源代码。各子系统当前的程序源文件放入SVN仓库code目录相应的bb目录下，对于一个 子系统又分多个分子系统的情况，应在该目录下分别建立几个相应的子目录。2.4.3发行文档的存放发行文档是指产品交付用户使用所必须的文件。包括：产品可执行文件，用户使用 说明书，联机帮助（HL

13、P）；资源文件（BMP，ICO等），环境配置文件等。以上文档作为制作发行盘的素材，放在 SVN 仓库发布文件目录的 Release 目录之 下，制作好的发行盘放在发布文件的 Setup 目录。2.5 权限控制管理为保障文档的安全性，一致性，以及防止意外修改，必须对不同的文档设置不同的 访问权限。文档权限类别：无任何权限，只读权限，所有权限。文档类别：设计文档，源码，发行文档。用户类别：开发人员、测试人员、项目经理、配置管理员等。为了控制不同的使用权限，根据要求在服务器上分别建立不同的用户，针对不同的 配置项所在目录分配不同的权限。为了便于管理，应以表格的形式列出人员与管理对象的访问关系（用户权限清 单），详见系统部SVN权限配置。3 备份管理为了保证文档的最大可恢复性，要随时及定期地进行备份工作。3.1 源文件备份开发人员每天都要将自已当日修改的源文件提交（commit）至SVN仓库。3.2 库文件备份为防止服务器出现异常，需对服务器上的 SVN 仓库文件进行备份，目前采用的方 案如下：工作日备份：每个工作日将原本位于 D 盘的仓库文件在 H 盘上备份一份，当 D 盘 仓库出现异常时，用户可把ROOT目录修改至H盘备份的目录，再进行更新操作。每周备份：每周五下班时将H盘备份文件异地备份至其它IP （目前备份在