版本管理制度

代碼版本管理規(guī)范v1.0研發(fā)部-2-4目錄TOC\o"1-3"文檔類別使用對象 31．引言 41.1目的 41.2范疇 41.3術(shù)語定義 41.4版序控制統(tǒng)計 51.5版本更新統(tǒng)計 52．版本管理 52．1版本標記辦法 52．1．1正式版本 52．2目錄構(gòu)造 62．3文檔的寄存 72.3.1現(xiàn)在版本和歷史版本的寄存 72.3.2開發(fā)文檔的寄存 72.3.3源代碼的寄存 72.3.4SQL語句的寄存 72.3.5發(fā)行文檔的寄存 72．4權(quán)限控制管理 83．更新管理（版本升級） 83.1版本升級原則 83.2新版本的公布 94．備份管理 95．顧客版本管理 106．研發(fā)部統(tǒng)一管理階段性版本 106.1階段性版本的提交到研發(fā)部 106.2階段性版本的公布到公司網(wǎng)站上 106.3各項目組新版本內(nèi)部及時備份。 117．版本工具的使用 117.1研發(fā)部采用svn配備管理工具 118．各項目組提交文檔及源碼以及規(guī)則 118.1各項目組需要提交的文檔 118.2現(xiàn)在所管理的產(chǎn)品列表 129．周報管理制度 1210．風(fēng)險管理制度 13文檔類別使用對象文檔類別該文檔是為公司提供一種版本管理規(guī)范性文獻。使用對象該文檔使用對象為公司研發(fā)本部各部門項目經(jīng)理及版本管理人員，以及其它有關(guān)人員。未經(jīng)許可，該文檔不得提供應(yīng)上述規(guī)定對象以外的人員閱讀或使用。 1．引言1.1目的本文檔是為規(guī)范公司研發(fā)版本管理而制訂的。1.2范疇本文檔為各產(chǎn)品部、事業(yè)部版本管理員提供有關(guān)版本管理規(guī)范的有關(guān)內(nèi)容，涉及：版本標記辦法軟件系統(tǒng)數(shù)據(jù)的寄存文檔的修改控制文檔的備份制度1.3術(shù)語定義SVNSvn是一種開源的版本控制系統(tǒng)Subversion的簡稱文檔 一種數(shù)據(jù)媒體和其上所統(tǒng)計的數(shù)據(jù)。配備管理標記和擬定系統(tǒng)中配備項的過程，在系統(tǒng)整個生存周期內(nèi)控制這些項的投放和更動，統(tǒng)計并報告配備的狀態(tài)和更動規(guī)定，驗證配備項的完整性和對的性。軟件配備軟件的具體形態(tài)在某時刻的瞬時影像。配備項軟件配備管理的對象稱為配備項，如：系統(tǒng)規(guī)格闡明書，項目開發(fā)計劃，顧客手冊，源碼?；€軟件生存周期中各開發(fā)階段末尾的標記，它的作用是把各階段工作的劃分更加明確化，使原來持續(xù)的工作在這些點上斷開，使之便于檢查和必定階段成果。1.4版序控制統(tǒng)計版序狀態(tài)擬稿審核同意公布日期1.0研發(fā)部陳建華/賴春華15/01/181.5版本更新統(tǒng)計*A-增加M-修改D-刪除版本/修訂版修改頁碼修改統(tǒng)計修改人日期1.0初始版本/022．版本管理2．1版本標記辦法為了使工作規(guī)范化、統(tǒng)一化，各項目組實施的版本標記管理辦法分為：正式版本和特殊版本。2．1．1正式版本公司在市場上發(fā)行的正規(guī)版本。以“V”開頭，版本號放后。V前面增加項目名稱，版本號分3節(jié)：主版本號，次版本號和內(nèi)部版本號，每節(jié)之間以小數(shù)點（.）間隔。如V2.0.1表達主版本號為2，次版本號為0，內(nèi)部版本號為1。研發(fā)部控制主版本號和次版本號，各項目組控制內(nèi)部版本號。例如：一體化平臺-平陰版v1.1.1,一體化平臺為產(chǎn)品名稱，平陰版為版本名稱（平陰為具體項目名稱），v1.1.1為主版本號+次版本號+內(nèi)部版本號。2．2目錄構(gòu)造由于各項目組的實際狀況不同，目錄構(gòu)造很難統(tǒng)一，但為了能更加好地管理各項目組的文檔，建議可將被管理的配備項分為三大類：文檔類、源碼類及安裝盤類，這樣寄存比較清晰，有助于版本管理。至于二級目錄是以版本劃分，并根據(jù)制訂的目錄構(gòu)造給出文獻級目錄清單（先給出源程序及文檔的文獻級目錄清單，安裝盤的可后來再執(zhí)行）：。表達正式版本及特殊版本的目錄按下列原則定義：正始版本：以“V”開頭，版本號放后，主版本號和次主版本號之間的“.”去掉，明細版本號之前加“-”。舉例以下：版本號目錄名V1.0V1.0V1.1V1.1V1.0.1V1.0.1V1.1.2V1.1.22．3文檔的寄存2.3.1現(xiàn)在版本和歷史版本的寄存對于源碼文獻，特別增加了一種Current目錄，寄存現(xiàn)在正在開發(fā)與維護的源碼文獻，現(xiàn)在未公布版本的全部數(shù)據(jù)都寄存在\CURRENT\下。一旦現(xiàn)在版本正式發(fā)行，則現(xiàn)在目錄被修改為對應(yīng)的歷史目錄。歷史版本是指已經(jīng)發(fā)行的版本，寄存在對應(yīng)的版本目錄之下，普通不允許改動。2.3.2開發(fā)文檔的寄存根據(jù)各項目部自己的狀況，將系統(tǒng)顧客需求統(tǒng)計、總體設(shè)計文檔、具體設(shè)計及數(shù)據(jù)構(gòu)造文獻、測試統(tǒng)計、顧客手冊等放入對應(yīng)的目錄下。2.3.3源代碼的寄存源代碼涉及如：java，jsp，BMP，ICO等有關(guān)文獻，是未經(jīng)編譯解決的、不能直接交付使用的產(chǎn)品文獻以及編譯產(chǎn)品所需的文獻；聯(lián)機協(xié)助文獻HLP在未生成HLP文獻之前的DOC，RTF等格式的文檔也視為源代碼。各子系統(tǒng)現(xiàn)在的程序源文獻放入對應(yīng)的目錄下。對于一種子系統(tǒng)又分多個分子系統(tǒng)的狀況，應(yīng)在該目錄下分別建立幾個對應(yīng)的目錄。2.3.4SQL語句的寄存各子系統(tǒng)SQL文獻放入…..\\SQL下，對于不同的數(shù)據(jù)庫，分別建立不同的子目錄，如oracle、mysql、db2等。公共SQL文獻直接放入…\SQL下即可，不同數(shù)據(jù)庫的特殊SQL分別放入對應(yīng)的子目錄下。2.3.5發(fā)行文檔的寄存發(fā)行文檔是指產(chǎn)品交付顧客使用所必須的文獻。涉及：產(chǎn)品可執(zhí)行文獻，顧客使用闡明書，聯(lián)機協(xié)助（HLP）；資源文獻（BMP，ICO等），環(huán)境配備文獻等。以上文檔作為制作發(fā)行盤的素材，放在RELEASE的REL_SRC目錄之下，制作好的發(fā)行盤放在RELEASE的SETUP目錄。2．4權(quán)限控制管理為保障文檔的安全性，一致性，以及避免意外修改，必須對不同的文檔設(shè)立不同的訪問權(quán)限。文檔權(quán)限類別：只讀權(quán)限，讀寫權(quán)限。文檔類別：設(shè)計文檔，源碼，發(fā)行文檔。顧客類別：開發(fā)人員、測試人員、分析設(shè)計人員、項目經(jīng)理、配備管理員、安裝盤制作人員、問題及需求管理人員、顧客文檔編寫人員等。為了控制不同的使用權(quán)限，根據(jù)規(guī)定在服務(wù)器上分別建立不同的顧客，針對不同的配備項所在目錄分派不同的權(quán)限。為了便于管理，應(yīng)以表格的形式列出人員與管理對象的訪問關(guān)系（顧客權(quán)限清單）。3．更新管理（版本升級）3.1版本升級原則版本升級應(yīng)嚴格納入版本管理的控制之下。應(yīng)當謹慎地控制版本的升級，保障高版本的向下兼容性，或提供嚴格定義的升級辦法。在下面幾個狀況下，進行版本演化和升級：1、當產(chǎn)品發(fā)生重大修改和改善時，主版本號加1。重大修改和改善涉及：平臺遷移；開發(fā)工具的遷移；體系構(gòu)造的變遷。2、當產(chǎn)品發(fā)生較小的改善或修改時，次版本號能夠加1。3、對于改動量比較少的，如修改產(chǎn)品的錯誤，可增加內(nèi)部版本號。內(nèi)部版本號對顧客來說是不可見的，只對項目部內(nèi)部版本控制有用。4、統(tǒng)計版本升級過程。每次版本升級，都要填寫版本升級統(tǒng)計表，統(tǒng)計表樣例以下：版本升級統(tǒng)計表版本號公布日期修改文獻問題簡要描述公布負責人同意人備注闡明：版本號：統(tǒng)計現(xiàn)在公布的版本。公布日期：該版本同意公布的日期。修改文獻：版本修改統(tǒng)計文獻，普通為版本修改日志。3.2新版本的公布新版本的公布涉及主版本號和次版本號的升級，普通不涉及內(nèi)部版本號的升級。流程以下：根據(jù)項目進展狀況，或者根據(jù)顧客需要進行公布準備。在指定目錄中，根據(jù)本次公布的版本號建立對應(yīng)的子目錄，將current下的全部內(nèi)容拷貝至新建目錄下?？稍谛陆夸浵陆eadme.txt，并加入對應(yīng)的內(nèi)容。readme.txt文獻是統(tǒng)計該版本與上一版本的不同，作過哪些改動。格式樣例以下：增加或修改功效涉及源文獻改動因素4．備份管理為了確保文檔的最大可恢復(fù)性，要隨時及定時地進行備份工作。隨時備份：開發(fā)人員每天都要將自已當天修改的源文獻在本地機器上進行備份。開發(fā)負責人每天要將全部源文獻在本地機備份。建議備份采用循環(huán)備份。定時備份備份形式為硬盤備份和光盤備份。硬盤備份時，要備份在獨立的硬盤上；光盤備份時，要將光盤寄存在可靠的地方。備份周期視各產(chǎn)品部、事業(yè)部的具體狀況而定。如果處在開發(fā)階段，每七天應(yīng)對全部的源程序項進行備份，普通為每七天周五；如果處在其它階段，根據(jù)具體狀況而定，但周期不能超出兩周。備份要由版本管理員負責，備份原則應(yīng)是確保文檔的最大可恢復(fù)性。對于歷史版本或某顧客的特殊版本，如果無特殊因素不再進行修改的話，建議用光盤進行備份，并且應(yīng)有備份盤闡明文獻BACKUP.TXT。該文獻應(yīng)當統(tǒng)計下列內(nèi)容：本次備份時間，備份內(nèi)容，執(zhí)行人。5．顧客版本管理 現(xiàn)在重要以做項目為主，是根據(jù)客戶規(guī)定開發(fā)的程序。為了更加好地管理源程序，應(yīng)為每一顧客建立一種顧客版本文獻，該文獻應(yīng)包含下列內(nèi)容：顧客編號：顧客名稱：軟件版本號：開始使用時間：聯(lián)系人：聯(lián)系電話：顧客程序更改日志樣例以下：更改時間版本號修改模塊名稱變更因素變更概述軟件位置變更人員備注闡明：顧客購置軟件時要為該顧客建立一種包含上述內(nèi)容的一種顧客版本文獻，并填寫有關(guān)數(shù)據(jù)。顧客進行版本更新時規(guī)定填寫該文獻的版本變更統(tǒng)計，用以反映顧客版本的變更狀況。6．研發(fā)部統(tǒng)一管理階段性版本6.1階段性版本的提交到研發(fā)部當各項目組更新了新版本后來，如果次版本號發(fā)生變化，各項目組配備管理員經(jīng)項目經(jīng)理同意后要把次版本修改的內(nèi)容（提交的內(nèi)容分為修改的源碼、新的文檔和安裝盤）提交給研發(fā)部版本管理人員。6.2階段性版本的公布到公司網(wǎng)站上產(chǎn)品新版本公布后來，及時在軟件演示環(huán)境中進行更新。并且新版本的特色和特點要在公司網(wǎng)站上進行公布，描述新版本特色的文檔要由各項目組進行提供應(yīng)項目部，經(jīng)項目部保存后，文檔提交給公司網(wǎng)站管理人員進行公布，方便供其它項目組和公司營銷人員進行理解。6.3各項目組新版本內(nèi)部及時備份。研發(fā)部負責進行全部產(chǎn)品版本的管理，但各個項目組也要自己進行備份。7．版本工具的使用7.1研發(fā)部采用svn配備管理工具研發(fā)部采用專門的配備管理服務(wù)器，此服務(wù)器只是專門用于版本的管理，普通不用于其它的應(yīng)用，配備管理軟件采用svn1.5進行配備管理。8．各項目組提交文檔及源碼以及規(guī)則8.1各項目組需要提交的文檔名稱成果描述立項申請書寫名此項目的價值、所需人力資源及費用、可行性分析、成本-效益分析、風(fēng)險分析立項評審報告評審結(jié)論、評審建議軟件需求闡明書目的客戶、業(yè)務(wù)流程、系統(tǒng)中的角色、子功效模塊介紹、質(zhì)量規(guī)定、界面規(guī)定系統(tǒng)設(shè)計闡明書系統(tǒng)約束、開發(fā)環(huán)境、數(shù)據(jù)流程圖、用例圖、模塊之間的關(guān)系圖、類函數(shù)文獻變量等命名規(guī)則、系統(tǒng)安全設(shè)計闡明、性能分析數(shù)據(jù)庫設(shè)計闡明書全部表名、表設(shè)計、表ER圖、生成庫的sql語句、存儲過程等。表及字段命名規(guī)則。顧客界面設(shè)計闡明書系統(tǒng)界面設(shè)計闡明、原型圖模塊設(shè)計闡明書編程的接口、重要的數(shù)據(jù)構(gòu)造、重要算法測試用例用例名稱、用例描述、輸入值、但愿輸出值缺點報告Bug名稱、bug狀態(tài)、bug緊急狀況、bug解決人等測試報告界面測試報告、性能測試報告布署闡明書布署環(huán)境闡明、初始化的數(shù)據(jù)、注意事項、數(shù)據(jù)的遷移等安裝和使用手冊安裝過程描述、各模塊使用手冊、FAQ手冊軟件源代碼源代碼、開發(fā)工具、API具體闡明、代碼注釋、編譯后程序系統(tǒng)維護統(tǒng)計問題描述、問題解決狀況技術(shù)評審報告評審內(nèi)容、評審成果、評審人系統(tǒng)安裝程序打包程序、打包工具、打包完后來的安裝程序8.2現(xiàn)在所管理的產(chǎn)品列表序列號產(chǎn)品名稱應(yīng)用范疇所屬項目組產(chǎn)品介紹1統(tǒng)一支付平臺收單研發(fā)部9．周報管理制度各項目組每七天向研發(fā)部提交周報。周報具體的格式以下：項目周報報告名稱所屬項目報告人報告日期本周工作報告1.任務(wù)進度