系統(tǒng)版本管理文檔

1、系統(tǒng)版本管理文檔目錄1. 引言 1.1. 目的 1.2. 范圍 1.3. 術(shù)語定義 1.4. 參考資料 1.5. 版本控制記錄 1.6. 版本更新記錄 2. 版本管理 2.1. 版本標示方法 正式版本 . 42.2. 目錄結(jié)構(gòu) 2.3. 文檔的存放 開發(fā)文檔的存放 . 源代碼的存放 . SQL的語句存放 發(fā)行文檔的存放 . 2.4. 配置管理流程 2.5. 權(quán)限控制的管理 3. 更新管理 3.1. 源程序的修改 3.2. 版本升級 版本升級原則 . 新版本發(fā)布 . 113.3. 文檔的變更 4. 備份管理 1. 引言版本控制就是對軟件開發(fā)過程中所創(chuàng)建的配置對象不同版本進行管理， 保證 任何時間

2、都可以取到正確的版本以及版本的組合。版本控制的主要功能是記錄開發(fā)過程中的每一次修改， 讓開發(fā)的工作可以隨 時檢查過往歷史記錄和獲得正確版本，是系統(tǒng)的成長記錄。1.1. 目的本文檔的編制是為了規(guī)范產(chǎn)品部、研發(fā)部、測試部對軟件產(chǎn)品版本的管理。1.2. 范圍 本文檔為產(chǎn)品部、研發(fā)部、測試部的管理員提供有關(guān)版本管理規(guī)范的相關(guān)內(nèi) 容，包括：版本標識方法軟件系統(tǒng)數(shù)據(jù)的存放文檔的修改控制文檔的備份制度1.3. 術(shù)語定義SCM軟件配置管理( Software Configuration Management )縮寫SVM軟件版本管理( Software Version Management )縮寫SVN 一個

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

4、序狀態(tài)部門擬稿審核批準發(fā)布日期1.0項目研發(fā)部1.11.6. 版本更新記錄A - 增加 M - 修改 D - 刪除版本 / 修訂版修改頁碼修改記錄修改人日期1.0初始版本1.12. 版本管理2.1. 版本標示方法為了使工作規(guī)范化、統(tǒng)一化，研發(fā)本部各部門實行的版本標識管理方法。2.1.1. 正式版本X：主版本號，用來表示提供給客戶的產(chǎn)品功能的主要增強。在一個極端的 例子中，主版本號的上升用來說明產(chǎn)品現(xiàn)在已經(jīng)擁有了一個全新的功能類。 從市 場和許可權(quán)的角度來看， 主版本號的升級相當于購買一個完全獨立的產(chǎn)品。 從開 發(fā)者角度來看，一個主版本號的迭代差不多總是反映了一個新的獨立分支或是其 主干還可以延

5、續(xù)主版本的生命期。Y：特征版本號，用來表示產(chǎn)品新增了一些特征，或者是在原來文檔中 描述的特征上作了重要的修改。 用來確定特征版本號什么時候需要修改的一個衡 量標準就是產(chǎn)品功能說明書。 產(chǎn)品的特征版本升級是在主版本之間保持產(chǎn)品競爭 力的一種重要機制。Z：缺陷修復版本號，用來表示在該版本上所做的缺陷維護行為的等 級。版修復版本是穩(wěn)定市場和最小化客戶技術(shù)支持費用負擔的一種重要機制。Alpha 版: 此版本表示該軟件在此階段主要是以實現(xiàn)軟件功能為主，通常只 在軟件開發(fā)者內(nèi)部交流，一般而言，該版本軟件的 Bug 較多，需要繼續(xù)修改。Beta 版: 該版本相對于 版已有了很大的改進， 消除了嚴重的錯誤，

6、但還是 存在著一些缺陷， 需要經(jīng)過多次測試來進一步消除， 此版本主要的修改對像是軟 件的 UI 。RC 版: 該版本已經(jīng)相當成熟了，基本上不存在導致錯誤的 BUG，與即將發(fā)行的正式版相差無幾Release版 : 該版本意味 “最終版本 ”，在前面版本的一系列測試版之后， 終歸 會有一個正式版本，是最終交付用戶使用的一個版本。 該版本有時也稱為標準版。 一般情況下， Release不會以單詞形式出現(xiàn)在軟件封面上， 取而代之的是符號 （R）。2.2. 目錄結(jié)構(gòu)由于各部門的實際情況不同， 目錄結(jié)構(gòu)很難統(tǒng)一， 但為了能更好地管理各部 門部文檔，建議可將被管理的配置項分為三大類：文檔類、源碼類及安裝盤類

7、， 這樣存放比較清晰，有利于版本管理。具體目錄如下表格所示：根目錄一級目錄二級目錄三級目錄項目名稱 +版本號源代碼（ SRC）集成代碼代碼的合并第一個模塊代碼第二個模塊代碼數(shù)據(jù)庫SQL公共開發(fā)包代碼文檔(DOC)立項文檔立項計劃書 立項申請書項目計劃項目開發(fā)計劃需求文檔需求規(guī)格說明書設(shè)計文檔設(shè)計概要說明書 數(shù)據(jù)庫設(shè)計說明書界面布局原型界面 動態(tài)頁面參考資料項目一些參考資料驗收文檔驗收資料測試文檔測試計劃 測試報告 測試用例試用信息測試部署部署材料發(fā)布（RELEAS）ESETUPRELEASE發(fā)布文檔2.3. 文檔的存放2.3.1. 開發(fā)文檔的存放文檔歸檔流程：2.3.2. 源代碼的存放2.3.

8、3. SQL的語句存放各子系統(tǒng) SQL文件放入 . SQL 下，對于不同的數(shù)據(jù)庫， 分別建立不同的子目錄，如 WAT、SYB、MSS、ORC、DB2等。公共 SQL文件直接放入 SQL 下即可，不同數(shù)據(jù)庫的特殊 SQL分別放入對應的子目錄下。2.3.4. 發(fā)行文檔的存放 發(fā)行文檔是指產(chǎn)品交付用戶使用所必須的文件。 包括：產(chǎn)品可執(zhí)行文件， 用 戶使用說明書，聯(lián)機幫助（ HLP）；資源文件（ BMP，ICO等），環(huán)境配置文件等。2.4. 配置管理流程流程說明：1. 開發(fā)人員完成所負責代碼模塊的編寫任務(wù)后，提交到項目經(jīng)理處；2. 項目經(jīng)理向測試部提交測試任務(wù)；3. 配置管理員準備測試所需環(huán)境；4.

9、測試員開始測試并提供實時測試 BUG；5. 開發(fā)人員處理測試人員提供的 BUG，并提交測試員進行回歸測試，直至 BUG關(guān) 閉；6. 測試完成后，測試人員提供測試報告；7. 根據(jù)項目情況決定是否發(fā)布新版本；8. 配置管理員與各成員確定好新版本的各項信息；9. 配置管理員發(fā)布新版本。2.5. 權(quán)限控制的管理 為保障文檔的安全性，一致性，以及防止意外修改，必須對不同的文檔設(shè)置 不同的訪問權(quán)限。文檔權(quán)限類別：只讀權(quán)限，讀寫權(quán)限。文檔類別： DOC，SRD， RELEAS。E用戶類別：開發(fā)人員、測試人員、分析設(shè)計人員、部門經(jīng)理、配置管理員、 安裝盤制作人員、問題及需求管理人員、用戶文檔編寫人員等。為了控

10、制不同的使用權(quán)限，根據(jù)要求在服務(wù)器上分別建立不同的用戶，針對 不同的配置項所在目錄分配不同的權(quán)限。為了便于各部門的管理，應以表格的形式列出人員與管理對象的訪問關(guān)系 (用戶權(quán)限清單)。3. 更新管理3.1. 源程序的修改 當開發(fā)小組在開發(fā)同一產(chǎn)品時，應能保障：各成員間的修改不會互相覆蓋； 程序員的修改能及時反映到產(chǎn)品的最新版本中。建議首先在相應子系統(tǒng)的下一級建一目錄， 如 checkout ，存放正在修改的文 檔及修改登記表。當某個程序員要修改某一文檔時，遵循以下程序：1) 接收維護任務(wù)；2) 查看需要修改的文件(如 PBL及 SQL等)是否正在被其它人員修改(檢查 checkout 目錄下是否

11、存在要修改的文件或后綴已改為該程序員姓名簡寫) ；3) 如果有人在修改該文件，等待或與相應的開發(fā)員聯(lián)系，重復2。否則繼續(xù)；4) 將該文件復制到 checkout 目錄下，在修改登記表中登記； 或?qū)⒃撐募?后綴改為本人姓名簡寫；5) 將該文件拷貝到自己的私有目錄；6) 根據(jù)要求修改源文件；7) 根據(jù)要求測試，并進行相關(guān)項的回歸測試；8) 交測試人員測試，如未通過，重復 6，如通過則繼續(xù)；9) 在 checkout 目錄中刪除該文件，并在修改登記表中標注修改完成；10) 將修改完畢的文件通過電子郵件或其它手段送交版本管理員，版本 管理員將文件復制到相應的路徑；如遇特殊情況(版本管理員出差) ，程

12、序員可 將修改完畢的文件復制到相應的路徑下，或?qū)⒑缶Y改回正式。11) 回復下達者，報告維護任務(wù)完成3.2. 版本升級3.2.1. 版本升級原則 版本升級應嚴格納入版本管理的控制之下。應當謹慎地控制版本的升 級，保障高版本的向下兼容性，或提供嚴格定義的升級方法。主版本號 (1)：當功能模塊有較大的變動，比如增加多個模塊或者整體架構(gòu) 發(fā)生變化。此版本號由項目決定是否修改。子版本號 (1)：當功能有一定的增加或變化，比如增加了對權(quán)限控制、增加 自定義視圖等功能。此版本號由項目決定是否修改。階段版本號 (1)：一般是 Bug 修復或是一些小的變動，要經(jīng)常發(fā)布修訂版， 時間間隔不限， 修復一個嚴重的 b

13、ug即可發(fā)布一個修訂版。 此版本號由項目經(jīng)理 決定是否修改。日期版本號 (140606):用于記錄修改項目的當前日期， 每天對項目的修改都需 要更改日期版本號。此版本號由開發(fā)人員決定是否修改。希臘字母版本號 (beta):此版本號用于標注當前版本的軟件處于哪個開發(fā)階 段，當軟件進入到另一個階段時需要修改此版本號。 此版本號由項目決定是否修 改。每次版本升級，要填寫版本升級記錄表，記錄表樣例如下：主版 本號子系統(tǒng)名稱子系統(tǒng)版本發(fā)布 日期變更功能描述發(fā)布人批準人備注主版本號：記錄當前發(fā)布的版本發(fā)布日期：該版本批準發(fā)布的日期 修改文件：版本修改記錄，版本修改日志3.2.2. 新版本發(fā)布新版本的發(fā)布包括主版本號和次版本號的升級， 一般不包括內(nèi)部版本號的升 級。流程如下：1) 接收新版本發(fā)布任務(wù)，接收本次發(fā)布的版本代號。2) 在指定目錄中，根據(jù)本次發(fā)布的版本號建立相應的子目錄，將 current 下的所有內(nèi)容拷貝至新建目錄下。3) 可在新建目錄下建立 readme.txt ，并加入相應的內(nèi)容。3.3. 文檔的變更文檔變更流程：4. 備份管理為了保證文檔的最大可恢復性，要隨時及定期地進行備份工作。1) 隨時備份： 開發(fā)人員每天都要將自已當日修改的源文件在本地機器