軟件研發(fā)版本管理制度93658

軟件版本管理制度1. 引言21.1 目的21.2 范圍21.3 術(shù)語(yǔ)定義21.4 版序控制記錄31.5 版本更新記錄32. 版本管理32.1 版本標(biāo)識(shí)方法32 11 正式版本42.2 目錄結(jié)構(gòu)42.3 文檔的存放62.3.1 當(dāng)前版本和歷史版本的存放62.3.2 開(kāi)發(fā)文檔的存放62.3.3 源代碼的存放62.3.4 sql語(yǔ)句的存放62.3.5 發(fā)行文檔的存放62.4 權(quán)限控制管理63. 更新管理（版本升級(jí)）73.1 版本升級(jí)原則73.2 新版本的發(fā)布74. 備份管理85. 用戶版本管理96. 研發(fā)部統(tǒng)一管理階段性版本96.1 階段性版本的提交到研發(fā)部96.2 階段性版本的發(fā)布到公司網(wǎng)站上96.3 各項(xiàng)目組新版本內(nèi)部及時(shí)備份。107. 版本工具的使用107.1 研發(fā)部采用svn 配置管理工具108. 各項(xiàng)目組提交文檔及源碼以及規(guī)則118.1 各項(xiàng)目組需要提交的文檔118.2 目前所管理的產(chǎn)品列表錯(cuò)誤！未定義書簽。9. 周報(bào)管理制度1210. 風(fēng)險(xiǎn)管理制度131. 引言1.1 目的本文檔是為規(guī)范軟件研發(fā)版本管理而制定的。1.2 范圍本文檔為各產(chǎn)品部、事業(yè)部版本管理員提供有關(guān)版本管理規(guī)范的相關(guān)內(nèi)容，包括： 版本標(biāo)識(shí)方法軟件系統(tǒng)數(shù)據(jù)的存放文檔的修改控制文檔的備份制度1.3 術(shù)語(yǔ)定義svnsvn是一個(gè)開(kāi)源的版本控制系統(tǒng)subversion 的簡(jiǎn)稱文檔一種數(shù)據(jù)媒體和其上所記錄的數(shù)據(jù)。配置管理標(biāo)識(shí)和確定系統(tǒng)中配置項(xiàng)的過(guò)程，在系統(tǒng)整個(gè)生存周期內(nèi)控制這些項(xiàng)的投放和更動(dòng)，記錄并報(bào)告配置的狀態(tài)和更動(dòng)要求，驗(yàn)證配置項(xiàng)的完整性和正確性。軟件配置軟件的具體形態(tài)在某時(shí)刻的瞬時(shí)影像。配置項(xiàng)軟件配置管理的對(duì)象稱為配置項(xiàng)，如：系統(tǒng)規(guī)格說(shuō)明書， 項(xiàng)目開(kāi)發(fā)計(jì)劃， 用戶手冊(cè)， 源碼?；€軟件生存周期中各開(kāi)發(fā)階段末尾的標(biāo)記，它的作用是把各階段工作的劃分更加明確化，使本來(lái)連續(xù)的工作在這些點(diǎn)上斷開(kāi)，使之便于檢驗(yàn)和肯定階段成果。1.4 版序控制記錄1.52. 版本管理2.1 版本標(biāo)識(shí)方法為了使工作規(guī)范化、統(tǒng)一化，各項(xiàng)目組實(shí)行的版本標(biāo)識(shí)管理方法分為：正式版本和特殊版本。2.1.1 正式版本公司在市場(chǎng)上發(fā)行的正規(guī)版本。以“v”開(kāi)頭，版本號(hào)放后。 v前面增加項(xiàng)目名稱，版本號(hào)分3 節(jié)：主版本號(hào)，次版本號(hào)和內(nèi)部版本號(hào)，每節(jié)之間以小數(shù)點(diǎn)（. ）間隔。如 v2.0.1 表示主版本號(hào)為2，次版本號(hào)為 0， 內(nèi)部版本號(hào)為1。研發(fā)部控制主版本號(hào)和次版本號(hào)，各項(xiàng)目組控制內(nèi)部版本號(hào)。例如：一體化平臺(tái)- 平陰版 v1.1.1,一體化平臺(tái)為產(chǎn)品名稱，平陰版為版本名稱（平陰為具體項(xiàng)目名稱）， v1.1.1為主版本號(hào) +次版本號(hào) +內(nèi)部版本號(hào)。2.2 目錄結(jié)構(gòu)由于各項(xiàng)目組的實(shí)際情況不同，目錄結(jié)構(gòu)很難統(tǒng)一，但為了能更好地管理各項(xiàng)目組的文檔，建議可將被管理的配置項(xiàng)分為三大類：文檔類、源碼類及安裝盤類， 這樣存放比較清晰， 有利于版本管理。至于二級(jí)目錄是以版本劃分，并根據(jù)制定的目錄結(jié)構(gòu)給出文件級(jí)目錄清單（先給出源程序及文檔的文件級(jí)目錄清單，安裝盤的可以后再執(zhí)行）：?，F(xiàn)以農(nóng)電平臺(tái) 1.0 的目錄結(jié)構(gòu)舉例如下：需求文檔用 戶需 求版本號(hào)在文件名記錄上標(biāo)識(shí)概要 設(shè)計(jì) 文總 體設(shè) 計(jì)按版本號(hào)依次類檔文檔推文(g:)檔數(shù)據(jù)庫(kù)設(shè)計(jì)詳細(xì) 設(shè)計(jì) 文檔測(cè)試用例測(cè)試記錄版本號(hào)在文件名上標(biāo)識(shí)用戶手冊(cè)用 戶使 用產(chǎn)品說(shuō)明書手冊(cè)項(xiàng)目計(jì)劃項(xiàng)目計(jì)劃實(shí)施手冊(cè)實(shí)施手冊(cè)月度計(jì)劃月度計(jì)劃安 裝盤rel_src產(chǎn)品盤或發(fā)布文檔(h:)setup發(fā)布文檔表示正式版本及特殊版本的目錄按以下原則定義：（1）正始版本： 以“v ”開(kāi)頭，版本號(hào)放后， 主版本號(hào)和次主版本號(hào)之間的“ .”去掉， 明細(xì)版本號(hào)之前加“ -”。舉例如下：版本號(hào)目錄名v1.0v1.0v1.1v1.1v1.0.1v1.0.1v1.1.2v1.1.22.3 文檔的存放2.3.1 當(dāng)前版本和歷史版本的存放對(duì)于源碼文件，特別增加了一個(gè) current 目錄，存放當(dāng)前正在開(kāi)發(fā)與維護(hù)的源碼文件， 當(dāng)前未發(fā)布版本的所有數(shù)據(jù)都存放在下。一旦當(dāng)前版本正式發(fā)行，則當(dāng)前目錄被修改為相應(yīng)的歷史目錄。歷史版本是指已經(jīng)發(fā)行的版本，存放在相應(yīng)的版本目錄之下，一般不允許改動(dòng)。2.3.2 開(kāi)發(fā)文檔的存放根據(jù)各項(xiàng)目部自己的情況，將系統(tǒng)用戶需求記錄、總體設(shè)計(jì)文檔、詳細(xì)設(shè)計(jì)及數(shù)據(jù)結(jié)構(gòu)文件、測(cè)試記錄、用戶手冊(cè)等放入相應(yīng)的目錄下。2.3.3 源代碼的存放源代碼包括如： java，jsp，bmp ，ico 等相關(guān)文件，是未經(jīng)編譯處理的、不能直接交付使用的產(chǎn)品文件以及編譯產(chǎn)品所需的文件；聯(lián)機(jī)幫助文件hlp 在未生成hlp文件之前的doc，rtf 等格式的文檔也視為源代碼。各子系統(tǒng)當(dāng)前的程序源文件放入相應(yīng)的目錄下。對(duì)于一個(gè)子系統(tǒng)又分多個(gè)分子系統(tǒng)的情況，應(yīng)在該目錄下分別建立幾個(gè)相應(yīng)的目錄。2.3.4 sql語(yǔ)句的存放各子系統(tǒng) sql 文件放入.sql 下，對(duì)于不同的數(shù)據(jù)庫(kù)，分別建立不同的子目錄， 如 oracle、sysbase、db2 等。公共 sql 文件直接放入sql 下即可， 不同數(shù)據(jù)庫(kù)的特殊sql 分別放入對(duì)應(yīng)的子目錄下。2.3.5 發(fā)行文檔的存放發(fā)行文檔是指產(chǎn)品交付用戶使用所必須的文件。包括：產(chǎn)品可執(zhí)行文件，用戶使用說(shuō)明書，聯(lián)機(jī)幫助（ hlp ）；資源文件（ bmp， ico 等），環(huán)境配置文件等。以上文檔作為制作發(fā)行盤的素材，放在release 的 rel_src 目錄之下，制作好的發(fā)行盤放在 release 的 setup 目錄。2.4 權(quán)限控制管理為保障文檔的安全性，一致性，以及防止意外修改，必須對(duì)不同的文檔設(shè)置不同的訪問(wèn)權(quán)限。文檔權(quán)限類別：只讀權(quán)限，讀寫權(quán)限。 文檔類別：設(shè)計(jì)文檔，源碼，發(fā)行文檔。用戶類別：開(kāi)發(fā)人員、測(cè)試人員、分析設(shè)計(jì)人員、項(xiàng)目經(jīng)理、配置管理員、安裝盤制作人員、問(wèn)題及需求管理人員、用戶文檔編寫人員等。為了控制不同的使用權(quán)限，根據(jù)要求在服務(wù)器上分別建立不同的用戶，針對(duì)不同的配置項(xiàng)所在目錄分配不同的權(quán)限。為了便于管理，應(yīng)以表格的形式列出人員與管理對(duì)象的訪問(wèn)關(guān)系（用戶權(quán)限清單）。3. 更新管理（版本升級(jí)）3.1 版本升級(jí)原則版本升級(jí)應(yīng)嚴(yán)格納入版本管理的控制之下。應(yīng)當(dāng)謹(jǐn)慎地控制版本的升級(jí)，保障高版本的向下兼容性，或提供嚴(yán)格定義的升級(jí)方法。在下面幾種情況下，進(jìn)行版本演化和升級(jí)：1、當(dāng)產(chǎn)品發(fā)生重大修改和改進(jìn)時(shí)，主版本號(hào)加1。重大修改和改進(jìn)包括：1） 平臺(tái)遷移；2） 開(kāi)發(fā)工具的遷移；3） 體系結(jié)構(gòu)的變遷。2、當(dāng)產(chǎn)品發(fā)生較小的改進(jìn)或修改時(shí)，次版本號(hào)可以加1。3、對(duì)于改動(dòng)量比較少的，如修改產(chǎn)品的錯(cuò)誤，可增加內(nèi)部版本號(hào)。內(nèi)部版本號(hào)對(duì)用戶來(lái)說(shuō)是不可見(jiàn)的，只對(duì)項(xiàng)目部?jī)?nèi)部版本控制有用。4、記錄版本升級(jí)過(guò)程。每次版本升級(jí)，都要填寫版本升級(jí)記錄表，記錄表樣例如下：版本升級(jí)記錄表說(shuō)明：版本號(hào)：記錄當(dāng)前發(fā)布的版本。發(fā)布日期：該版本批準(zhǔn)發(fā)布的日期。修改文件：版本修改記錄文件，一般為版本修改日志。3.2 新版本的發(fā)布新版本的發(fā)布包括主版本號(hào)和次版本號(hào)的升級(jí)，一般不包括內(nèi)部版本號(hào)的升級(jí)。流程如下：1、根據(jù)項(xiàng)目進(jìn)展情況，或者根據(jù)用戶需要進(jìn)行發(fā)布準(zhǔn)備。2、在指定目錄中，根據(jù)本次發(fā)布的版本號(hào)建立相應(yīng)的子目錄，將current 下的所有內(nèi)容拷貝至新建目錄下。3、可在新建目錄下建立readme.txt，并加入相應(yīng)的內(nèi)容。readme.txt文件是記錄該版本與上一版本的不同，作過(guò)哪些改動(dòng)。格式樣例如下：4. 備份管理為了保證文檔的最大可恢復(fù)性，要隨時(shí)及定期地進(jìn)行備份工作。1、隨時(shí)備份：（1） ） 開(kāi)發(fā)人員每天都要將自已當(dāng)日修改的源文件在本地機(jī)器上進(jìn)行備份。（2） ） 開(kāi)發(fā)負(fù)責(zé)人每天要將所有源文件在本地機(jī)備份。（3） ） 建議備份采用循環(huán)備份。2、定期備份（1） 備份形式為硬盤備份和光盤備份。硬盤備份時(shí)，要備份在獨(dú)立的硬盤上；光盤備份時(shí)，要將光盤存放在可靠的地方。（2） 備份周期視各產(chǎn)品部、事業(yè)部的具體情況而定。如果處于開(kāi)發(fā)階段，每周應(yīng)對(duì)所有的源程序項(xiàng)進(jìn)行備份，一般為每周周五；如果處于其它階段，根據(jù)具體情況而定，但周期不能超過(guò)兩周。（3） 備份要由版本管理員負(fù)責(zé)，備份原則應(yīng)是保證文檔的最大可恢復(fù)性。（4） 對(duì)于歷史版本或某用戶的特殊版本，如果無(wú)特殊原因不再進(jìn)行修改的話，建議用光盤進(jìn)行備份， 而且應(yīng)有備份盤說(shuō)明文件 backup.txt 。該文件應(yīng)該記錄以下內(nèi)容：本次備份時(shí)間，備份內(nèi)容，執(zhí)行人。5. 用戶版本管理目前主要以做項(xiàng)目為主，是根據(jù)客戶要求開(kāi)發(fā)的程序。為了更好地管理源程序，應(yīng)為每一用戶建立一個(gè)用戶版本文件，該文件應(yīng)包含以下內(nèi)容：用戶編號(hào)： 用戶名稱： 軟件版本號(hào)：開(kāi)始使用時(shí)間： 聯(lián)系人：聯(lián)系電話：用戶程序更改日志樣例如下：更改版本號(hào)修改模變更原因變更概述軟件位置變更備注時(shí)間塊名稱人員說(shuō)明：1） 用戶購(gòu)買軟件時(shí)要為該用戶建立一個(gè)包含上述內(nèi)容的一個(gè)用戶版本文件，并填寫有關(guān)數(shù)據(jù)。2） 用戶進(jìn)行版本更新時(shí)要求填寫該文件的版本變更記錄，用以反映用戶版本的變更情況。6. 研發(fā)部統(tǒng)一管理階段性版本6.1 階段性版本的提交到研發(fā)部當(dāng)各項(xiàng)目組更新了新版本以后，如果次版本號(hào)發(fā)生改變，各項(xiàng)目組配置管理員經(jīng)項(xiàng)目經(jīng)理批準(zhǔn)后要把次版本修改的內(nèi)容（提交的內(nèi)容分為修改的源碼、新的文檔和安裝盤）提交給研發(fā)部版本管理人員。6.2 階段性版本的發(fā)布到公司網(wǎng)站上產(chǎn)品新版本發(fā)布以后，及時(shí)在軟件演示環(huán)境中進(jìn)行更新。并且新版本的特色和特點(diǎn)要在 公司網(wǎng)站上進(jìn)行發(fā)布，描述新版本特色的文檔要由各項(xiàng)目組進(jìn)行提供給項(xiàng)目部，經(jīng)項(xiàng)目部保 存后，文檔提交給公司網(wǎng)站管理人員進(jìn)行發(fā)布，以便供其他項(xiàng)目組和公司營(yíng)銷人員進(jìn)行了解。6.3 各項(xiàng)目組新版本內(nèi)部及時(shí)備份。研發(fā)部負(fù)責(zé)進(jìn)行所有產(chǎn)品版本的管理，但各個(gè)項(xiàng)目組也要自己進(jìn)行備份。7. 版本工具的使用7.1 研發(fā)部采用 svn 配置管理工具研發(fā)部采用專門的配置管理服務(wù)器，此服務(wù)器只是專門用于版本的管理，一般不用于其他的應(yīng)用，配置管理軟件采用svn1.5 進(jìn)行配置管理。8. 各項(xiàng)目組提交文檔及源碼以及規(guī)則8.1 各項(xiàng)目組需要提交的文檔9. 周報(bào)管理制度各項(xiàng)目組每周向研發(fā)部提交周報(bào)。周報(bào)具體的格式如