軟件版本管理文檔

1、. 軟件版本管理規(guī)范軟件版本管理規(guī)范 文檔編號：文檔編號：ZZ-ZD-7.3-2013 編制： 楊忠林 審核: 批準(zhǔn): 目錄 . . 1引言引言 .3 1.1目的.3 1.2范圍.3 1.3術(shù)語定義.3 1.4版序控制記錄.4 1.5版本更新記錄.4 2版本管理版本管理 .4 2.1流程圖.4 2.2版本命名.7 2.2.1 外部版本命名說明.7 2.2.2 內(nèi)部版本命名說明.7 2.2.3 內(nèi)外部版本的關(guān)系.7 2.3版本升級.7 2.3.1版本升級原則.7 2.3.2新版本的發(fā)布.8 2.4目錄結(jié)構(gòu).8 2.5文檔的存放.9 2.5.1文本文件的存放.9 2.5.2源代碼的存放.9 2.5

2、.3發(fā)行文檔的存放.9 2.6權(quán)限控制管理.10 3備份管理備份管理 .10 3.1源文件備份.10 3.2庫文件備份.10 4用戶版本管理用戶版本管理 .10 5版本工具的使用版本工具的使用 .11 5.1配置管理工具.11 5.2SVN 的使用.11 5.2.1常用命令.11 5.2.2簡單操作.12 5.2.3版本分支管理.12 . . 1 引言引言 1.1 目的目的 本文檔是為規(guī)范 xxxx 科技有限公司軟件版本管理而制定的。 1.2 范圍范圍 本文檔為系統(tǒng)軟件開發(fā)部版本管理員提供有關(guān)版本管理規(guī)范的相關(guān)內(nèi)容，包括： 版本標(biāo)識方法 軟件系統(tǒng)數(shù)據(jù)的存放 文檔的修改控制 文檔的備份制度 1.

3、3 術(shù)語定義術(shù)語定義 SVN SVN是一個開源的版本控制系統(tǒng) Subversion 的簡稱 文檔 一種數(shù)據(jù)媒體和其上所記錄的數(shù)據(jù)。 配置管理 標(biāo)識和確定系統(tǒng)中配置項的過程，在系統(tǒng)整個生存周期內(nèi)控制這些項的投放和更動， 記錄并報告配置的狀態(tài)和更動要求，驗證配置項的完整性和正確性。 軟件配置 軟件的具體形態(tài)在某時刻的瞬時影像。 配置項 軟件配置管理的對象稱為配置項，如：系統(tǒng)規(guī)格說明書，項目開發(fā)計劃，用戶手冊， 源碼。 基線 軟件生存周期中各開發(fā)階段末尾的標(biāo)記，它的作用是把各階段工作的劃分更加明確 化，使本來連續(xù)的工作在這些點上斷開，使之便于檢驗和肯定階段成果。 . . 1.4 版序控制記錄版序控制

4、記錄 版序狀態(tài)擬稿審核批準(zhǔn)發(fā)布日期 1.0系統(tǒng)軟件開發(fā)部 1.5 版本更新記錄版本更新記錄 *A - 增加 M - 修改 D - 刪除 版本/修訂版修改頁碼修改記錄修改人日期 1.0初始版本 2 版本管理版本管理 2.1 流程圖流程圖 2.1.1 文檔歸檔流程文檔歸檔流程 文檔編寫人員評審人員配置管理員 2.1.2 文檔變更流程文檔變更流程 編寫文檔 修改文檔 格式規(guī)范化檢查 打評審版本 文檔評審 確定版本 （歸檔入庫） 通過不通過 . . 變更申請人評審人員文檔編寫人員配置管理員 2.1.3 代碼歸檔流程代碼歸檔流程 開發(fā)人員測試人員配置管理員 2.1.4 代碼變更流程代碼變更流程 提交變更

5、 變更影響分 析及審批 變更實施 取消變更 更新版本 （歸檔入庫） 文檔評審 通過 通過 不通過 不通過 源代碼入庫從 CVS 庫提取源代碼進(jìn)行編譯 制作安裝程序 打測試版本 系統(tǒng)測試 從 CVS 庫提取源代碼 修改源代碼 入庫： 安裝程序 源代碼 測試報告 評審報告 更新版本 通過 不通過 . . 變更申請人評審人員開發(fā)人員測試人員配置管理員 2.1.5 配置管理流程配置管理流程 流程說明： 1、開發(fā)人員完成所負(fù)責(zé)模塊的代碼編寫任務(wù)后，提交到項目經(jīng)理處 2、項目經(jīng)理向測試部門提交測試任務(wù) 3、配置管理員準(zhǔn)備測試所需的環(huán)境 4、測試人員開展測試并實時提交 BUG 5、開發(fā)人員處理測試過程中所出

6、現(xiàn)的 BUG，并提交給測試人員進(jìn)行回歸測試，直至 BUG 被關(guān)閉 6、測試基本完成后，測試人員提交測試報告 7、項目情況根據(jù)實際情況決定是否發(fā)布新的版本 8、配置管理員與各相關(guān)人員經(jīng)討論后確定好新版本各項信息 9、配置管理員發(fā)布新版本 開發(fā)人員項目管理人員測試人員配置管理員 完成開發(fā)任務(wù)提交測試任務(wù) 更新測試環(huán)境 提交發(fā)布請求 提交測試報告 確定版本信息 制做安裝程序 處理 BUG 新版本發(fā)布入庫 輸出給市場部 發(fā)布文檔更新 測試執(zhí)行 提交變更 取消變更 變更影響分 析及審批 變更實施代碼測試 測試報告 評審 通過 更新版本 （歸檔入庫） 不通過 不通過 通過 測試計劃、用例 回歸測試 . .

7、 2.2 軟件版本命名軟件版本命名 2.2.1 外部版本命名說明外部版本命名說明 公司對外銷售、宣傳、所使用的兩位版本號，也正是軟件產(chǎn)品登記證所使用的版本號。例： V1.0 2.2.2 內(nèi)部版本命名說明內(nèi)部版本命名說明 內(nèi)部版本號由四部分組成，第一個 1 為主版本號，第二個 1 為子版本號，第三個 1 為階段版本號，第四部分為日期版本號加希臘字母版本號，希臘字母版本號共有 5 種， 分別為：Base 、Alpha、Beta、RC、Release。例如：1.1.1.051021_Beta。對于小項目或 子系統(tǒng)而言，可簡化為.，如 1.0.0。 *主版本號：當(dāng)功能模塊有較大的變動，比如增加多個模塊

8、或者整體架構(gòu)發(fā)生變化。 此版本號由項目決定是否修改。 *子版本號：當(dāng)功能有一定的增加或變化，比如增加了對權(quán)限控制、增加自定義視 圖等功能。此版本號由項目決定是否修改。 *階段版本號：一般是 Bug 修復(fù)或是一些小的變動，要經(jīng)常發(fā)布修訂版，時間間 隔不限，修復(fù)一個嚴(yán)重的 Bug 即可發(fā)布一個修訂版。此版本號由項目經(jīng)理決定是否修 改。 *日期版本號用于記錄修改項目的當(dāng)前日期，每天對項目的修改都需要更改日期版 本號。此版本號由開發(fā)人員決定是否修改。 * Base 版: 剛出型； * Alpha 版: 此版本表示該軟件在此階段主要是以實現(xiàn)軟件功能為主，通常只在軟 件開發(fā)者內(nèi)部交流，一般而言，該版本軟件

9、的 Bug 較多，需要繼續(xù)修改。 * Beta 版: 該版本相對于 版已有了很大的改進(jìn)，消除了嚴(yán)重的錯誤，但還是存在 著一些缺陷，需要經(jīng)過多次測試來進(jìn)一步消除，此版本主要的修改對像是軟件的 UI。 * RC 版: 該版本已經(jīng)相當(dāng)成熟了，基本上不存在導(dǎo)致錯誤的 BUG，與即將發(fā)行的 正式版相差無幾。 * Release 版: 該版本意味“最終版本”，在前面版本的一系列測試版之后，終歸會有 一個正式版本，是最終交付用戶使用的一個版本。該版本有時也稱為標(biāo)準(zhǔn)版。一般情 況下，Release 不會以單詞形式出現(xiàn)在軟件封面上，取而代之的是符號(R)。 2.2.3 內(nèi)外部版本的關(guān)系內(nèi)外部版本的關(guān)系 外部版本

10、和內(nèi)容版本兩項沒有絕對關(guān)系，只有字典對應(yīng)關(guān)系。軟件領(lǐng)用登記表 在領(lǐng)導(dǎo)用，必須填外部版本和內(nèi)容版本兩項，都必須填寫。 例： 外部版本內(nèi)部版本序列號客戶領(lǐng)用人備注 還原影像 存檔與通 訊系統(tǒng) V2.0V2.0.0.1 （簽字） . . 2.2.1 版本升級原則版本升級原則 版本升級應(yīng)嚴(yán)格納入版本管理的控制之下。應(yīng)當(dāng)謹(jǐn)慎地控制版本的升級，保障高版 本的向下兼容性，或提供嚴(yán)格定義的升級方法。 在下面幾種情況下，進(jìn)行版本演化和升級： 1、當(dāng)產(chǎn)品發(fā)生重大修改和改進(jìn)時，主版本號加 1。重大修改和改進(jìn)包括： 1）平臺遷移； 2）開發(fā)工具的遷移； 3）體系結(jié)構(gòu)的變遷。 2、當(dāng)產(chǎn)品發(fā)生較小的改進(jìn)或修改時，次版本號

11、可以加 1。 3、對于改動量比較少的，如修改產(chǎn)品的錯誤，可升級修訂版本號。 4、記錄版本升級過程。每次版本升級，都要填寫版本升級記錄表，記錄表樣例如 下： 版本升級記錄表 主版本子系統(tǒng)名稱子系統(tǒng)版本發(fā)布日期功能變更描述發(fā)布責(zé)任人批準(zhǔn)人備注 說明： 版本號： 記錄當(dāng)前發(fā)布的版本。 發(fā)布日期：該版本批準(zhǔn)發(fā)布的日期。 修改文件：版本修改記錄文件，一般為版本修改日志。 2.2.2 新版本的發(fā)布新版本的發(fā)布 新版本的發(fā)布包括主版本號和次版本號的升級，一般不包括內(nèi)部版本號的升級。流 程如下： 1、根據(jù)項目進(jìn)展情況，或者根據(jù)用戶需要進(jìn)行發(fā)布準(zhǔn)備。 2、將發(fā)布所需文件進(jìn)行打包，放在指定目錄中，給目錄加上標(biāo)簽

12、Tag，標(biāo)簽中 包含將要發(fā)布的版本信息。 3、同樣對源碼文件也要加上與版本信息相關(guān)的標(biāo)簽 Tag。 標(biāo)簽 Tag 命名規(guī)則如下： 組成：模塊首字母+下劃線+文件類型+下劃線+主版本號+次版本號+內(nèi)部版本號+ 時間（+下劃線+合并標(biāo)記） . . 樣例：qzcj_src_1_0_0_110923，qzcj 表示采集模塊的首字母，src 表示源碼， 1_0_0 表示將要發(fā)布的版本號，合并標(biāo)記可省略，只在有合并操作時注明，其中 合并前的標(biāo)記為 mbe， 合并后的標(biāo)記為 maf。 2.3 目錄結(jié)構(gòu)目錄結(jié)構(gòu) 但為了能更好地管理各項目組的文檔，建議可將被管理的配置項分為三大類：文檔 類、源碼類及安裝盤類，這

13、樣存放比較清晰，有利于版本管理，現(xiàn)將目錄結(jié)構(gòu)整理如 下： 根目錄根目錄一級目錄一級目錄二級目錄二級目錄對應(yīng)配置項對應(yīng)配置項備注備注 前置采集源碼 后臺計算源碼 業(yè)務(wù)應(yīng)用源碼 數(shù)據(jù)庫SQL 文件 業(yè)務(wù)支撐 源碼 code 公用開發(fā)包 需求文檔立項報告、需求分析、需 求記錄 設(shè)計文檔軟件架構(gòu)、總體設(shè)計、概 要設(shè)計、詳細(xì)設(shè)計、界面 設(shè)計 數(shù)據(jù)庫文檔數(shù)據(jù)字典、數(shù)據(jù)庫搭建、 備份還原方案、PDM 設(shè)計 測試文檔測試計劃、測試用例、測 試報告 用戶文檔用戶手冊、產(chǎn)品說明 計劃文檔項目計劃、年度月度計劃 外部接口文檔 文檔 doc 標(biāo)準(zhǔn)規(guī)范 SETUP releaserar 文件 resp 發(fā)布文件 發(fā)布文

14、檔 二級目錄中的版本指一些特殊的版本，不影響基線版本。 . . 2.4 文檔的存放文檔的存放 2.4.1 文本文件的存放文本文件的存放 根據(jù)各項目部自己的情況，將系統(tǒng)用戶需求記錄、總體設(shè)計文檔、詳細(xì)設(shè)計及數(shù)據(jù) 結(jié)構(gòu)文件、測試記錄、用戶手冊等放入 SVN 倉庫 doc 目錄相應(yīng)的子目錄下。 2.4.2 源代碼的存放源代碼的存放 源代碼包括如：h,cs，BMP，ICO 等相關(guān)文件，是未經(jīng)編譯處理的、不能直接交付 使用的產(chǎn)品文件以及編譯產(chǎn)品所需的文件；聯(lián)機幫助文件 HLP 在未生成 HLP 文件之前 的 DOC，RTF 等格式的文檔也視為源代碼。 各子系統(tǒng)當(dāng)前的程序源文件放入 SVN 倉庫 code

15、 目錄相應(yīng)的 bb 目錄下，對于一個 子系統(tǒng)又分多個分子系統(tǒng)的情況，應(yīng)在該目錄下分別建立幾個相應(yīng)的子目錄。 2.4.3 發(fā)行文檔的存放發(fā)行文檔的存放 發(fā)行文檔是指產(chǎn)品交付用戶使用所必須的文件。包括：產(chǎn)品可執(zhí)行文件，用戶使用 說明書，聯(lián)機幫助（HLP） ；資源文件（BMP，ICO 等） ，環(huán)境配置文件等。 以上文檔作為制作發(fā)行盤的素材，放在 SVN 倉庫發(fā)布文件目錄的 Release 目錄之 下，制作好的發(fā)行盤放在發(fā)布文件的 Setup 目錄。 2.5 權(quán)限控制管理權(quán)限控制管理 為保障文檔的安全性，一致性，以及防止意外修改，必須對不同的文檔設(shè)置不同的 訪問權(quán)限。 文檔權(quán)限類別：無任何權(quán)限，只讀權(quán)

16、限，所有權(quán)限。 文檔類別：設(shè)計文檔，源碼，發(fā)行文檔。 用戶類別：開發(fā)人員、測試人員、項目經(jīng)理、配置管理員等。 為了控制不同的使用權(quán)限，根據(jù)要求在服務(wù)器上分別建立不同的用戶，針對不同的 配置項所在目錄分配不同的權(quán)限。 為了便于管理，應(yīng)以表格的形式列出人員與管理對象的訪問關(guān)系（用戶權(quán)限清單） ， 詳見系統(tǒng)部 SVN 權(quán)限配置 。 . . 3 備份管理備份管理 為了保證文檔的最大可恢復(fù)性，要隨時及定期地進(jìn)行備份工作。 3.1 源文件備份源文件備份 開發(fā)人員每天都要將自已當(dāng)日修改的源文件提交（commit）至 SVN 倉庫。 3.2 庫文件備份庫文件備份 為防止服務(wù)器出現(xiàn)異常，需對服務(wù)器上的 SVN

17、倉庫文件進(jìn)行備份，目前采用的方 案如下： 工作日備份：每個工作日將原本位于 D 盤的倉庫文件在 H 盤上備份一份，當(dāng) D 盤 倉庫出現(xiàn)異常時，用戶可把 ROOT 目錄修改至 H 盤備份的目錄，再進(jìn)行更新操作。 每周備份：每周五下班時將 H 盤備份文件異地備份至其它 IP（目前備份在 192.168.1.68 上） 。 每月備份：每個月底將最新版本備份至光盤。 4 用戶版本管理用戶版本管理 為了更好地管理源程序，應(yīng)為每一用戶建立一個用戶版本文件，該文件應(yīng)包含以下 內(nèi)容： 用戶編號：001 用戶名稱：xxxxxxxx 軟件版本號：2.0.0.0 開始使用時間：2010.8.11 聯(lián)系人：楊 xx

18、聯(lián)系電話用戶程序更改日志樣例如下： 更改 時間 版本號修改模 塊名稱 變更原因變更概述軟件位置變更 人員 備注 . . 說明： 1）用戶購買軟件時要為該用戶建立一個包含上述內(nèi)容的一個用戶版本文件，并填 寫有關(guān)數(shù)據(jù)。 2）用戶進(jìn)行版本更新時要求填寫該文件的版本變更記錄，用以反映用戶版本的變 更情況。 5 版本工具的使用版本工具的使用 5.1 配置管理工具配置管理工具 開發(fā)部采用 SVN 進(jìn)行配置管理，SVN 是一個 C/S 系統(tǒng)，多個開發(fā)人員通過一個中心 版本控制系統(tǒng)來記錄文件版本，從而達(dá)到保證文件同步的目的。 目前采用的 SVN 服務(wù)端為 VisualSVN-2.6.

19、4，客戶端為 TortoiseSVN-1.8.2.24708 5.2 SVN 的使用的使用 5.2.1 常用命令常用命令 英文命令中文命令操作、說明備注 Checkout提取/取出將文件下載到本地目錄第一次下載目錄用 Commit提交將改動過的文件提交到版本庫每次對文件更新后使用 Update更新將文件同步到最新版本獲取最新版本 Tag標(biāo)簽給某個版本添加一個標(biāo)記符號便于合并分支與主線 Branch分支創(chuàng)建某個文件的分支建立特殊版本時用到 Merge合并將分支文件（或主文件）的更改合并到主文件 （或分支文件） diff比較不同比較任意兩個版本間的不同 Reversion Graph 版本分支圖查

20、看文件各版本（包括分支文件）的走向圖查詢各個版本及 Tag History歷史查看文件各個版本更新歷史查詢版本詳細(xì)信息 5.2.2 簡單操作簡單操作 文件提取：初次使用需將源文件從倉庫提取出來，執(zhí)行 checkout 命令將庫文件提取至本地相應(yīng) 位置。 定時更新：開發(fā)人員每天早上對源代碼或文件進(jìn)行更新操作（右鍵執(zhí)行 update 操作） 。 實時更新：某一開發(fā)人員提交更改后，可通知其它人員進(jìn)行更新操作。 . . 實時提交：對某一文件進(jìn)行更改完成后，執(zhí)行 commit 命令將更改提交至倉庫，更改前先進(jìn)行 更新操作，如多個人員對同一文件同時進(jìn)行操作，會產(chǎn)生沖突，這時需要對沖突進(jìn)行處理。 沖突處理：

21、提交產(chǎn)生沖突時，先對文件進(jìn)行同步（即更新）操作，之后會產(chǎn)生一個合并文件， 前為當(dāng)前服務(wù)器最新版本 修改的內(nèi)容，找到最近提交該文件的同事，進(jìn)行協(xié)商后對源文件進(jìn)行修改并提交。 創(chuàng)建分支/標(biāo)簽：右鍵菜單中選擇Branch或Tag找開創(chuàng)建對話框，輸入 Branch 名或 Tag 名，選中Create new branch/Create new tag ，點擊 OK 即可。 查看版本/歷史：文件（非文件夾）右健菜單中選擇Revision Graph.或History. ，可查看 該文件的版本更新記錄或歷史信息。 5.2.3 版本分支管理版本分支管理 我們把一個項目的主要開發(fā)過程稱作開發(fā)基線。當(dāng)某一個特殊事件發(fā)生的時候，例 如，有一個用戶有特殊的需求，于是就從這個開發(fā)基線里分離出來一個叉，以滿足用 戶特殊的需求，這個叉有它自己的發(fā)展方向，這就是分支。 -分