軟件版本管理制度文檔

軟件版管理規(guī)系統(tǒng)軟件開發(fā)部2011-9-201

目錄引言..................................................................................................................................................................1.41.5

目的..........................................................................................................................................................2范圍..........................................................................................................................................................3術(shù)語(yǔ)定義..................................................................................................................................................3版序控制記錄..........................................................................................................................................3版本更新記錄..........................................................................................................................................42

版本管理.............................................................................................................................................................32.6

流程圖......................................................................................................................................................4版本命名..................................................................................................................................................5版本升級(jí)..................................................................................................................................................5..................................................................................................................................5..................................................................................................................................6目錄結(jié)構(gòu)..................................................................................................................................................6文檔的存放..............................................................................................................................................7..............................................................................................................................7..................................................................................................................................7..............................................................................................................................7權(quán)限控制管理..........................................................................................................................................83

備份管理..........................................................................................................................................................83.13.2

源文件備份..............................................................................................................................................8庫(kù)文件備份..............................................................................................................................................8

用戶版本管..................................................................................................................................................9版本工具的用..............................................................................................................................................95.1

配置管理工具..........................................................................................................................................95.2CVS的使用............................................................................................................................................25.2.3

........................................................................................................................................10........................................................................................................................................10................................................................................................................................101引言1.1目的本文檔是為規(guī)范XXXXXX有限司軟件版本管理而制的。1.2范圍本文檔為系統(tǒng)軟件發(fā)部版本管理員供有關(guān)版本管理范的相關(guān)內(nèi)容，包括

版本標(biāo)識(shí)方法軟件系統(tǒng)數(shù)據(jù)的存文檔的修改控制文檔的備份制度1.3術(shù)語(yǔ)定CVSCVS是一個(gè)開的版本控制系統(tǒng)ConcurrentVersionsSystem的簡(jiǎn)稱一種數(shù)據(jù)媒體和其所記錄的數(shù)據(jù)。管理標(biāo)識(shí)和確定系統(tǒng)中置項(xiàng)的過(guò)程，在統(tǒng)整個(gè)生存周期控制這些項(xiàng)的投放和動(dòng)，記錄并報(bào)告配置的態(tài)和更動(dòng)要求，證配置項(xiàng)的完整和正確性。配置軟件的具體形態(tài)在時(shí)刻的瞬時(shí)影像項(xiàng)軟件配置管理的對(duì)稱為配置項(xiàng)，如系統(tǒng)規(guī)格說(shuō)明書項(xiàng)目開發(fā)計(jì)劃，用戶冊(cè)，源碼。軟件生存周期中各發(fā)階段末尾的標(biāo)，它的作用是把階段工作的劃分更加確化，使本來(lái)連續(xù)的作在這些點(diǎn)上斷，使之便于檢驗(yàn)肯定階段成果。編寫文檔修改文檔格式規(guī)范編寫文檔修改文檔格式規(guī)范化檢查打評(píng)審版本確定版本（歸檔入庫(kù)）不通過(guò)通過(guò)文檔編寫人員評(píng)審人員配置管理員文檔評(píng)審1.4版序控制錄版序狀態(tài)擬稿審核批準(zhǔn)發(fā)布日期1.0系統(tǒng)軟件開發(fā)部1.5版本更記錄*A-增加M-修改

D-刪除版本/修訂版修改頁(yè)碼修改記錄修改人日期1.0初始版本2版本管理2.1流程圖2.1.1文檔歸檔程2.1.2文檔變更程提交變更變更實(shí)施取消變更更新版本（歸檔入庫(kù)）源代碼入庫(kù)從提交變更變更實(shí)施取消變更更新版本（歸檔入庫(kù)）源代碼入庫(kù)從CVS庫(kù)提取源代碼進(jìn)行譯制作安裝程序打測(cè)試版本從CVS庫(kù)提取源代碼修改源代碼入庫(kù)：安裝程序源代碼測(cè)試報(bào)告評(píng)審報(bào)告更新版本通過(guò)不通過(guò)不通過(guò)通過(guò)不通過(guò)通過(guò)變更申請(qǐng)人評(píng)審人員文檔編寫人員配置管理員變更影響分析及審批文檔評(píng)審開發(fā)人員測(cè)試人員配置管理員系統(tǒng)測(cè)試2.1.3代碼歸檔程2.1.4代碼變更程完成開發(fā)任務(wù)提交測(cè)試任務(wù)更新測(cè)試環(huán)境提交發(fā)布請(qǐng)求提交測(cè)試報(bào)告確定完成開發(fā)任務(wù)提交測(cè)試任務(wù)更新測(cè)試環(huán)境提交發(fā)布請(qǐng)求提交測(cè)試報(bào)告確定版本信息制做安裝程序處理BUG新版本發(fā)布入庫(kù)輸出給市場(chǎng)部發(fā)布文檔更新測(cè)試執(zhí)行提交變更取消變更變更實(shí)施代碼測(cè)試更新版本（歸檔入庫(kù)）測(cè)試計(jì)劃、用例回歸測(cè)試通過(guò)不通過(guò)不通過(guò)變更申請(qǐng)人評(píng)審人員開發(fā)人員測(cè)試人員配置管理員通過(guò)變更影響分析及審批測(cè)試報(bào)告評(píng)審開發(fā)人員項(xiàng)目管理人員測(cè)試人員配置管理員2.1.5配置管理程流程說(shuō)明：開發(fā)人員完成所負(fù)責(zé)模塊的代碼編寫任務(wù)后，提交到項(xiàng)目經(jīng)處項(xiàng)目經(jīng)理向測(cè)試部門提交測(cè)試任務(wù)配置管理員準(zhǔn)備測(cè)試所需的環(huán)境測(cè)試人員開展測(cè)試并實(shí)時(shí)提交BUG開發(fā)人員處理測(cè)試過(guò)程中所出現(xiàn)的BUG，并提交給測(cè)試員進(jìn)行回歸測(cè)試，直BUG被關(guān)閉6、測(cè)試基本完成后測(cè)試人員提交測(cè)試報(bào)告項(xiàng)目情況根據(jù)實(shí)際情況決定是否發(fā)布新的版本配置管理員與各相關(guān)人員經(jīng)討論后確定好新版本各項(xiàng)信息配置管理員發(fā)布新版本2.2軟件版本名軟件版本號(hào)由四部組成，第一個(gè)1主版本號(hào)，第二1為子版本號(hào)，第三1為階段版本號(hào)，第部分為日期版本加希臘字母版本，希臘字母版本號(hào)共5種，分別為：AlphaBeta、、Release。如：51021_Beta。于小項(xiàng)目或子系而言，可簡(jiǎn)化為<主本號(hào)>.<次版本號(hào)>.<修版本號(hào)>，如1.0.0。*主版本號(hào)：當(dāng)功模塊有較大的變，比如增加多個(gè)塊或者整體架構(gòu)發(fā)生化。此版本號(hào)由項(xiàng)目決是否修改。*子版本號(hào)：當(dāng)功有一定的增加或化，比如增加了權(quán)限控制、增加自定視圖等功能。此版本由項(xiàng)目決定是否改。*階段版本號(hào)：般是Bug修復(fù)或是一些小的變動(dòng)要經(jīng)常發(fā)布修訂版，間間隔不限，修復(fù)一個(gè)重的Bug即可發(fā)一個(gè)修訂版。此本號(hào)由項(xiàng)目經(jīng)理定是否修改。*日期版本號(hào)用于錄修改項(xiàng)目的當(dāng)日期，每天對(duì)項(xiàng)的修改都需要更改日版本號(hào)。此版本號(hào)由發(fā)人員決定是否改。*Alpha版:此版本表示該軟件此階段主要是以現(xiàn)軟件功能為主通常只在軟件開發(fā)者內(nèi)部交流一般而言，該版軟件的Bug較多需要繼續(xù)修改。*Beta版:該版本相對(duì)于α版已了很大的改進(jìn)，除了嚴(yán)重的錯(cuò)誤，還是存在著一些缺陷，需要過(guò)多次測(cè)試來(lái)進(jìn)步消除，此版本要的修改對(duì)像是軟件UI。*RC版:該版本已經(jīng)相成熟了，基本上不存導(dǎo)致錯(cuò)誤的BUG，即將發(fā)行的正式版相差無(wú)幾。*Release版:該版本意味“最終版”，在前面版的一系列測(cè)試版后，終歸會(huì)有一個(gè)正式版本，是終交付用戶使用一個(gè)版本。該版有時(shí)也稱為標(biāo)準(zhǔn)版。般情況下，Release不會(huì)以單詞形式現(xiàn)在軟件封面上取而代之的是符號(hào)R)。2.3版本升2.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)包括：平臺(tái)遷移；開發(fā)工具的遷移；體系結(jié)構(gòu)的變遷。當(dāng)產(chǎn)品發(fā)生較小的進(jìn)或修改時(shí)，次本號(hào)可以加1。對(duì)于改動(dòng)量比較少，如修改產(chǎn)品的誤，可升級(jí)修訂本號(hào)。4、記錄版本升級(jí)程。每次版本升級(jí)，要填寫版本升級(jí)錄表，記錄表樣例下：版本升級(jí)記錄表主版本子系統(tǒng)名稱子系統(tǒng)版本發(fā)布日期功能變更描述發(fā)布責(zé)任人批準(zhǔn)人備注說(shuō)明：版本號(hào)：記錄當(dāng)前發(fā)布的版本。發(fā)布日期：該版本準(zhǔn)發(fā)布的日期。修改文件：版本修記錄文件，一般版本修改日志。2.3.2新版本的布新版本的發(fā)布包括版本號(hào)和次版本的升級(jí)，一般不括內(nèi)部版本號(hào)的升級(jí)流程如下：根據(jù)項(xiàng)目進(jìn)展情況或者根據(jù)用戶需進(jìn)行發(fā)布準(zhǔn)備。將發(fā)布所需文件進(jìn)打包，放在指定錄中，給目錄加標(biāo)簽Tag標(biāo)簽中包含將要發(fā)布的版信息。同樣對(duì)源碼文件也加上與版本信息關(guān)的標(biāo)簽Tag。標(biāo)簽Tag命名規(guī)如下：組成：模塊首字母+下劃線+文件類型+劃線+主版本+次版本號(hào)+內(nèi)部本號(hào)+時(shí)間（+下劃+合并標(biāo)記）樣例：qzcj_src_1_0_0_110923qzcj表示采集模塊的首字母，src表源碼，1_0_0表示將要發(fā)的版本號(hào)，合并記可省略，只在有合操作時(shí)注明，其合并前的標(biāo)記為mbe，合后的標(biāo)記為maf。2.4目錄結(jié)但為了能更好地管各項(xiàng)目組的文檔建議可將被管理配置項(xiàng)分為三大類：檔類、源碼類及安裝類，這樣存放比清晰，有利于版管理，現(xiàn)將目錄結(jié)構(gòu)理如下：根目錄一級(jí)目錄二級(jí)目錄對(duì)應(yīng)配置項(xiàng)備注resp源碼前置采集源碼resp源碼后臺(tái)計(jì)算源碼code業(yè)務(wù)應(yīng)用源碼code數(shù)據(jù)庫(kù)SQL文件code業(yè)務(wù)支撐code公用開發(fā)包文檔doc需求文檔立項(xiàng)報(bào)告、需求分析、需求記錄文檔doc設(shè)計(jì)文檔軟件架構(gòu)、總體設(shè)計(jì)、概要設(shè)計(jì)、詳細(xì)設(shè)計(jì)、界面設(shè)計(jì)文檔doc數(shù)據(jù)庫(kù)文檔數(shù)據(jù)字典、數(shù)據(jù)庫(kù)搭建、備份還原方案、PDM設(shè)計(jì)文檔doc測(cè)試文檔測(cè)試計(jì)劃、測(cè)試用例、測(cè)試報(bào)告文檔doc用戶文檔用戶手冊(cè)、產(chǎn)品說(shuō)明文檔doc計(jì)劃文檔項(xiàng)目計(jì)劃、年度月度計(jì)劃文檔doc外部接口文檔文檔doc標(biāo)準(zhǔn)規(guī)范發(fā)布文件SETUP發(fā)布文件releaserar文件發(fā)布文件發(fā)布文檔二級(jí)目錄中的版本一些特殊的版本不影響基線版本2.5文檔的放2.5.1文本文件存放根據(jù)各項(xiàng)目部自己情況，將系統(tǒng)用需求記錄、總體計(jì)文檔、詳細(xì)設(shè)計(jì)及據(jù)結(jié)構(gòu)文件、測(cè)試記、用戶手冊(cè)等放CVS倉(cāng)庫(kù)doc目相應(yīng)的子目錄下。2.5.2源代碼的放源代碼包括如：java，，BMP，等相關(guān)文件，是未經(jīng)編譯理的、不能直接交付使用的產(chǎn)品文以及編譯產(chǎn)品所的文件；聯(lián)機(jī)幫文件HLP在未生成HLP文件之前的DOCRTF等格式的文檔也視源代碼。各子系統(tǒng)當(dāng)前的程源文件放入CVS倉(cāng)庫(kù)code目相應(yīng)的bb目錄下，對(duì)于一個(gè)子系統(tǒng)又分多個(gè)分系統(tǒng)的情況，應(yīng)該目錄下分別建幾個(gè)相應(yīng)的子目錄。2.5.3發(fā)行文檔存放發(fā)行文檔是指產(chǎn)品付用戶使用所必的文件。包括：品可執(zhí)行文件，用戶用說(shuō)明書，聯(lián)機(jī)幫助HLP源文件（BMP，ICO等境配置文件等。以上文檔作為制作行盤的素材，放CVS倉(cāng)庫(kù)發(fā)布文件目的Release目錄之下，制作好的發(fā)行放在發(fā)布文件的Setup目錄。2.6權(quán)限控管理為保障文檔的安全，一致性，以及止意外修改，必對(duì)不同的文檔設(shè)置不的訪問(wèn)權(quán)限。文檔權(quán)限類別：無(wú)何權(quán)限，只讀權(quán)，所有權(quán)限。文檔類別：設(shè)計(jì)文，源碼，發(fā)行文。用戶類別：開發(fā)人、測(cè)試人員、項(xiàng)經(jīng)理、配置管理等。為了控制不同的使權(quán)限，根據(jù)要求服務(wù)器上分別建不同的用戶，針對(duì)不的配置項(xiàng)所在目錄分不同的權(quán)限。為了便于管理，應(yīng)表格的形式列出員與管理對(duì)象的問(wèn)關(guān)系（用戶權(quán)限清詳見(jiàn)《系統(tǒng)部CVS權(quán)限配置3備份管理為了保證文檔的最可恢復(fù)性，要隨及定期地進(jìn)行備工作。3.1源文件份開發(fā)人員每天都要自已當(dāng)日修改的文件提交（commit）至倉(cāng)庫(kù)。3.2庫(kù)文件份為防止服務(wù)器出現(xiàn)常，需對(duì)服務(wù)器的CVS倉(cāng)庫(kù)文件進(jìn)行份，目前采用的案如下：工作日備份：每個(gè)作日將原本位于盤的倉(cāng)庫(kù)文件在盤上備份一份，當(dāng)盤倉(cāng)庫(kù)出現(xiàn)異常時(shí)，戶可把ROOT目錄修改至H盤備份的錄，再進(jìn)行更新作。每周備份：每周五班時(shí)將H盤備份件異地備份至其IP（目前備份在8上每月備份：每個(gè)月將最新版本備份光盤。4用戶版本管理為了更好地管理源序，應(yīng)為每一用建立一個(gè)用戶版文件，該文件應(yīng)包含下內(nèi)容：用戶編號(hào)：用戶名稱：軟件版本號(hào)：開始使用時(shí)間：聯(lián)系人：聯(lián)系電話：用戶程序更改日志例如下：更改時(shí)間版本號(hào)修改模塊名稱變更原因變更概述軟件位置變更人員備注說(shuō)明：用戶購(gòu)買軟件時(shí)要該用戶建立一個(gè)含上述內(nèi)容的一用戶版本文件，并填寫有關(guān)數(shù)據(jù)。用戶進(jìn)行版本更新要求填寫該文件版本變更記錄，以反映用戶版本的變更情況。5版本工具的使用5.1配置管工具開發(fā)部采用CVS進(jìn)配置管理，CVS一個(gè)C/S系統(tǒng)，多個(gè)發(fā)人員通過(guò)一個(gè)心版本控制系統(tǒng)來(lái)記文件版本，從而到保證文件同步目的。目前采用的CVS服端為cvsnt-2.5.03.2260，戶端為TortoiseCVS-1.8.29。5.2CVS的使用5.2.1常用命令英文命令中文命令操作、說(shuō)明備注Checkout提取/取出將文件下載到本地目錄第一次下載目錄用Commit提交將改動(dòng)過(guò)的文件提交到版本庫(kù)每次對(duì)文件更新后使用Update更新將文件同步到最新版本獲取最新版本Tag標(biāo)簽給某個(gè)版本添加一個(gè)標(biāo)記符號(hào)便于合并分支與主線Branch分支創(chuàng)建某個(gè)文件的分支建立特殊版本時(shí)用到Merge合并將分支文件（或主文件）的更改合并到主文件（或分支文件）diff比較不同比較任意兩個(gè)版本間的不同ReversionGraph版本分支圖查看文件各版本（包括分支文件）的走向圖查詢各個(gè)版本及TagHistory歷史查看文件各個(gè)版本更新歷史查詢版本詳細(xì)信息5.2.2簡(jiǎn)單操作文件提?。撼醮问褂眯鑼⒃次募膫}(cāng)庫(kù)提取出來(lái)，執(zhí)行checkout命令將庫(kù)文件提取至本地相應(yīng)位置。定時(shí)更新：開發(fā)人員每天早上對(duì)源代碼或文件進(jìn)行更新操作右鍵執(zhí)行update操實(shí)時(shí)更新：某一開發(fā)人員提交更改后，可通知其它人員進(jìn)行新操作。實(shí)時(shí)提交：對(duì)某一文件進(jìn)行更改完成后，執(zhí)行commit命將更改提交至倉(cāng)庫(kù)，改前先進(jìn)行更新操作，如多個(gè)人員對(duì)同一文件同時(shí)進(jìn)行操作，會(huì)產(chǎn)生沖，這時(shí)需要對(duì)沖突進(jìn)處理。沖突處理：提交產(chǎn)生沖突時(shí)，先對(duì)文件進(jìn)行同步（即更新）作，之后會(huì)產(chǎn)生一個(gè)并文件，