版本管理制度

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