軟件研發(fā)配置管理規(guī)范

1、軟件研發(fā)配置管理規(guī)范一、目的與意義為了保證研發(fā)中心研發(fā)項(xiàng)目文件的安全性、機(jī)密性；保證軟件產(chǎn)品的完整性有效性及可追溯性，特制訂本規(guī)范。二、適用對(duì)象本辦法適用于軟件產(chǎn)業(yè)本部下屬相關(guān)軟件經(jīng)營(yíng)單位或部門三、術(shù)語(yǔ)術(shù)語(yǔ)描述軟件配置管理是在項(xiàng)目開發(fā)中，標(biāo)識(shí)、控制和管理軟件變更的一種管理?；€是項(xiàng)目開發(fā)庫(kù)中每個(gè)工件版本在特定時(shí)期的一個(gè)“快照”。它提供一個(gè)正式標(biāo)準(zhǔn)，隨后的工作基于此標(biāo)準(zhǔn)，并且只有經(jīng)過(guò)授權(quán)后才能變更這個(gè)標(biāo)準(zhǔn)。建立個(gè)初女口基線后，以后母次對(duì)其進(jìn)仃的變更都將記錄為個(gè)差值，直到建成下一個(gè)基線。開發(fā)庫(kù)（devlib）存放開發(fā)過(guò)程中需要保留的各種信息，供開發(fā)人員個(gè)人專用。開發(fā)人員對(duì)其具有編輯、修改、刪除等操

2、作權(quán)限基線庫(kù)(baselib)開發(fā)庫(kù)中產(chǎn)品經(jīng)過(guò)測(cè)試小組測(cè)試后，仃成一個(gè)穩(wěn)定的版本，由配置管理員從開發(fā)庫(kù)中將該版本提取出來(lái)，行成一個(gè)新的版本。以后的版本更新將在此基礎(chǔ)上進(jìn)行更新。所有人員對(duì)基線庫(kù)的最大權(quán)限只能為只讀權(quán)限。四、角色與職責(zé)角色職責(zé)項(xiàng)目經(jīng)理確定配置項(xiàng)、確定配置庫(kù)目錄權(quán)限；審查配置庫(kù)變更；項(xiàng)目開發(fā)過(guò)程中，監(jiān)督配置庫(kù)使用情況；員工離職時(shí)，配置庫(kù)歸檔完整性審核。開發(fā)小組根據(jù)配置管理制度規(guī)范，進(jìn)行配置庫(kù)的日常使用測(cè)試小組從開發(fā)庫(kù)中取出版本進(jìn)行整合測(cè)試;負(fù)責(zé)驗(yàn)證代碼變更及修改是否正確執(zhí)行。測(cè)試小組測(cè)試通過(guò)的版本方可放入基線庫(kù)。研發(fā)中心對(duì)項(xiàng)目中的變更進(jìn)行管理、監(jiān)控；協(xié)調(diào)開發(fā)小組、測(cè)試小組、配置管理

3、員進(jìn)行配置庫(kù)的優(yōu)化和管理。配置管理員負(fù)責(zé)配置庫(kù)的建立、權(quán)限設(shè)置、負(fù)責(zé)培訓(xùn)開發(fā)人員使用配置管理工具、對(duì)配置庫(kù)使用情況進(jìn)行管理和監(jiān)督、建立配置庫(kù)基線；定期備份配置庫(kù)；建立和完善配置管理制度。五、配置管理范圍1）配置管理包括：所有研發(fā)項(xiàng)目文檔、源代碼、可執(zhí)行程序，特殊工具及相關(guān)資料等。2) 項(xiàng)目文檔：立項(xiàng)建議書、項(xiàng)目計(jì)劃、需求分析報(bào)告、概要/詳細(xì)設(shè)計(jì)說(shuō)明書、數(shù)據(jù)庫(kù)表結(jié)構(gòu)、測(cè)試文檔以及項(xiàng)目過(guò)程中管理類文檔。3) 特殊工具及其相關(guān)資料指開發(fā)或測(cè)試過(guò)程中比較特殊的工具，以及其使用文檔等，如覺(jué)得有必要也納入配置庫(kù)的管理。六、配置庫(kù)建立流程圖如下：配置管理訃劃計(jì)劃評(píng)審配置庫(kù)建7：各項(xiàng)冃經(jīng)理硏發(fā)中心公同配置管理

4、員研發(fā)、測(cè)試、質(zhì)戢管理人員建庫(kù)收到成功通知及配置管理計(jì)劃通知建庫(kù)成功和項(xiàng)冃經(jīng)理進(jìn)存溝逋編輯配胃管理管理計(jì)劃1) 項(xiàng)目立項(xiàng)時(shí)，由項(xiàng)目經(jīng)理申請(qǐng)建立項(xiàng)目配置庫(kù)，配置管理員與項(xiàng)目經(jīng)理確定配置項(xiàng)，并參考附錄二：配置庫(kù)目錄結(jié)構(gòu)，建立配置庫(kù)以及配置庫(kù)目錄結(jié)構(gòu)；項(xiàng)目經(jīng)理提供配置庫(kù)權(quán)限清單(內(nèi)容應(yīng)包括員工姓名、項(xiàng)目名稱、目錄權(quán)限等)，由配置管理員為相關(guān)人員的設(shè)置配置權(quán)限。2) 配置庫(kù)權(quán)限設(shè)置完成之后，由配置管理員將配置庫(kù)名稱、訪問(wèn)路徑、訪問(wèn)權(quán)限等信息以郵件方式通知各相關(guān)人員；配置庫(kù)使用人員以各自的用戶名和密碼進(jìn)行訪問(wèn)配置庫(kù)。3) 配置庫(kù)密碼只能在服務(wù)器上設(shè)置，如配置庫(kù)使用人員密碼遺忘，可以與配置管理員取得聯(lián)系，

5、進(jìn)行修改密碼。七、配置庫(kù)權(quán)限變更管理1) 若在使用配置庫(kù)的過(guò)程中需要變更配置庫(kù)管理權(quán)限，可以由項(xiàng)目配置管理員或項(xiàng)目經(jīng)理以郵件或口頭方式通知配置管理員，配置管理員變更之后，將變更結(jié)果以電子郵件方式通知受影響的人員、項(xiàng)目經(jīng)理、項(xiàng)目配置管理員及其相關(guān)人員。2) 配置管理員根據(jù)配置庫(kù)權(quán)限變更頻率，決定每隔一段時(shí)間將配置庫(kù)權(quán)限清單與各項(xiàng)目經(jīng)理進(jìn)行審核確認(rèn)，各項(xiàng)目經(jīng)理審核后，若有權(quán)限需要進(jìn)行變更，應(yīng)及時(shí)通知配置管理員。八、測(cè)試階段配置庫(kù)使用流程流程圖如下：提交測(cè)試根告測(cè)試Mil在測(cè)試區(qū)取版本項(xiàng)M紳.埠開發(fā)人員測(cè)試人員開始測(cè)試一代碼編譯Rug修改完咸分配bug任務(wù)放到發(fā)佈包中建立版本分支完善文檔厲，程序提交

6、亍U測(cè)試區(qū)1）配置庫(kù)基本結(jié)構(gòu)如“附錄二”所示，通常以項(xiàng)目名稱作為一級(jí)目錄，二級(jí)目錄包括：trunk、manager、test、tag：其中“trunk”目錄通常為項(xiàng)目組開發(fā)人員具有讀寫權(quán)限，其他人根據(jù)需求進(jìn)行相應(yīng)權(quán)限設(shè)置。該目錄包含doc（文檔）、src（代碼）目錄；src下包括四個(gè)目錄：demo、源代碼、發(fā)布包、數(shù)據(jù)庫(kù)，其中“發(fā)布包”內(nèi)容為空；> “manager”目錄通常為研發(fā)中心和項(xiàng)目相關(guān)人員共同使用；> “test”目錄為測(cè)試人員使用；由于開發(fā)人員需要將發(fā)布包放置在該目錄下，所以開發(fā)人員對(duì)該目錄也具有讀寫權(quán)限，但其不允許修改除“測(cè)試版本”目錄外的其它目錄的內(nèi)容。> “

7、tag”目錄放置發(fā)布版本，只有項(xiàng)目組開發(fā)人員對(duì)其具有讀寫權(quán)限；開發(fā)人員在該目錄下不允許對(duì)源代碼等文件進(jìn)行修改，但需將代碼編譯后放置在“發(fā)布包”目錄下，同時(shí)將版本說(shuō)明等測(cè)試人員需要的項(xiàng)目文檔放在該目錄下。注：配置庫(kù)權(quán)限根據(jù)實(shí)際情況可以進(jìn)行調(diào)整。2）以PM_V1.0項(xiàng)目為例說(shuō)明測(cè)試時(shí)配置庫(kù)使用流程：當(dāng)項(xiàng)目經(jīng)理確定項(xiàng)目需要提交測(cè)試時(shí),由項(xiàng)目開發(fā)人員通過(guò)branch/tag的方式將“src”在tag目錄下建立版本分支，例如圖中的PM_V1.0B1001,其下內(nèi)容包括trunk/src下所有內(nèi)容,開發(fā)人員在PM_v1.0B1001下編譯后,將編譯后的文件放在“tag/PM_v1.0B1001/發(fā)布包”目

8、錄下,同時(shí)需將版本說(shuō)明文檔等相關(guān)文檔放在該目錄下。3）“發(fā)布包”中的內(nèi)容完善之后，項(xiàng)目開發(fā)人員將“tag/PM_V1.0B1001'/發(fā)布包”在“test/測(cè)試版本”目錄下建立tag，tag名稱為“PM_vl.0B1001”（即對(duì)應(yīng)發(fā)布版本名稱），其下內(nèi)容為發(fā)布包中的內(nèi)容。SrpOEEljTTiiESTJeiLu-Ldl.a(H-7JEI5E-.yWM-MZLCfWEl3IK-M2bflrDJatK-7-lflaHlDI；3MM龍胞01»»-MZLGtCrlJlJdSMZIDOtDI30卜比1站$恥Hiti.ad<O>ETO-HZI.6I+W3JK-?-

9、J2LiiSft3a(K-7-RlaIBHD粒»»-Hzwf4；nJKS<-JEL6Sft3h£&ISDJ»-i,-JlWICcJDa(K-7-l?laS-.5iiKta-7-:i2LSfISdEJM6T惟訪晶卻SW-M2I6-I+-W=口IWIT乩nrttpMrepEtwEcanQm_d.Den稱于jSSi啊悅.*JBd-Lj冃吃Sj4二爼則艮-bugEJPHjiJffllMHIdim卜Q*rrft+bBM£ODSt-oiia寸Jtj巾徐SOtQ陋CRH+Jj-心云'1U助酗£a皿+o如日PSK£Ot

10、n卜Q*rrft卜U?SST心黜遲E?tef如P貉也1juihcrmujIKcl勺曲中帰tfflffHt?M-ailie:it.rui®iodjHtAisLmih-i悄1區(qū)|.匕加此匕14護(hù)血止4訛祁Ol聞曲圖一4) 測(cè)試人員針對(duì)“test/測(cè)試版本/PM_V1.0B1001”下的發(fā)布包進(jìn)行測(cè)試。5) 若需發(fā)布新的版本,請(qǐng)重復(fù)24步驟。九、基線庫(kù)建立流程圖如下：評(píng)審基線庫(kù)il-研發(fā)中七基線庫(kù)建立申請(qǐng)表基線庫(kù)的建立各項(xiàng)目經(jīng)理研發(fā)巾心公司配置筲理員研發(fā)、測(cè)試、質(zhì)呈辻理人員得到版本發(fā)布通知建基線庫(kù)發(fā)布版本重新整理基線庫(kù)*編輯研發(fā)中心堆線庫(kù)建立申請(qǐng)騏1) 開發(fā)庫(kù)經(jīng)測(cè)試小組整合測(cè)試完成后，配置

11、庫(kù)達(dá)到一個(gè)階段的穩(wěn)定版本，由項(xiàng)目經(jīng)理向研發(fā)中心和配置管理員提出申請(qǐng)，建立基線庫(kù)。2) 由項(xiàng)目經(jīng)理、測(cè)試小組負(fù)責(zé)人確定開發(fā)庫(kù)中通過(guò)測(cè)試的對(duì)應(yīng)版本號(hào)，并填寫研發(fā)中心基線庫(kù)建立申請(qǐng)表。項(xiàng)目經(jīng)理、測(cè)試人員必須保證準(zhǔn)備進(jìn)入基線庫(kù)中的所有文檔、代碼、可執(zhí)行程序等相互對(duì)應(yīng)，保證準(zhǔn)備入庫(kù)資料的完整性和一致性。3) 項(xiàng)目經(jīng)理將研發(fā)中心基線庫(kù)建立申請(qǐng)表提交給配置管理員。4) 配置管理員根據(jù)研發(fā)中心基線庫(kù)建立申請(qǐng)表中相應(yīng)內(nèi)容建立基線庫(kù)，將正確的版本對(duì)應(yīng)的所有資料納入基線庫(kù)管理。5) 基線庫(kù)使用者的權(quán)限只能為只讀權(quán)限。使用者向項(xiàng)目經(jīng)理或部門經(jīng)理提出權(quán)限需求，在領(lǐng)導(dǎo)同意之后，配置管理員設(shè)置相應(yīng)權(quán)限，并通知相應(yīng)人員。十、

12、配置庫(kù)備份1)配置管理員應(yīng)定期做好配置庫(kù)的備份，以防意外引起的服務(wù)器上資料的丟失，避免給公司帶來(lái)嚴(yán)重的損失。2)配置管理員每周進(jìn)行硬盤備份一次，每?jī)蓚€(gè)月進(jìn)行光盤備份一次,備份后的光盤標(biāo)記上備份日期并附上內(nèi)容清單，移交公司保管。十一、配置庫(kù)使用1)所有立項(xiàng)的項(xiàng)目，都必須申請(qǐng)建立配置庫(kù)。開發(fā)過(guò)程中所有文檔和代碼必須納入配置庫(kù)管理，若因未納入配置庫(kù)管理造成的資料丟失或版本差異，其責(zé)任皆由開發(fā)人員及項(xiàng)目經(jīng)理承擔(dān)。2)配置庫(kù)服務(wù)器密碼只有配置管理員和研發(fā)中心掌握，其他人如因特殊原因需要該密碼，必須經(jīng)過(guò)研發(fā)中心批準(zhǔn)后方能獲??；并在使用完密碼之后，通知研發(fā)中心和配置管理員，配置管理員及時(shí)設(shè)置新的密碼，以保證

13、服務(wù)器資料的安全性和機(jī)密性。3) 各配置庫(kù)的使用人員必須使用各自的用戶名和密碼進(jìn)入配置庫(kù)，訪問(wèn)各自的配置庫(kù)。各使用人員不得將自己的用戶名和密碼泄漏給其他人員，若因泄露密碼而引起的后果將由泄漏密碼者本人承擔(dān)。4) 項(xiàng)目組成員未經(jīng)項(xiàng)目經(jīng)理同意不得更改他人的文檔和代碼。各項(xiàng)目的配置庫(kù)用于項(xiàng)目組正式開發(fā)使用，項(xiàng)目組成員不得惡意對(duì)其進(jìn)行修改、刪除、增加等操作；若因?qū)VN工具不熟悉，需要學(xué)習(xí)，可以向配置管理員提出需求，由配置管理員為其提供可以練習(xí)的配置庫(kù)。5) 各項(xiàng)目經(jīng)理負(fù)責(zé)定期檢查配置庫(kù)的使用情況，查看是否有員工進(jìn)行無(wú)故刪除或惡意修改文件的行為;并對(duì)開發(fā)人員提交的文檔和代碼的及時(shí)性、準(zhǔn)確性和完整性進(jìn)行

14、檢查。6) 在研發(fā)人員離職時(shí)，由其項(xiàng)目經(jīng)理負(fù)責(zé)檢查配置庫(kù)，檢查該人員提交的代碼或文檔是否完全放入配置庫(kù)管理，確認(rèn)版本和相應(yīng)文件完整無(wú)誤后，項(xiàng)目經(jīng)理在“員工離職申請(qǐng)單”中簽字，該員工方可離職。同時(shí)項(xiàng)目經(jīng)理應(yīng)及時(shí)通知配置管理員，取消該人員的所有權(quán)限。若因項(xiàng)目經(jīng)理審核不細(xì)致造成的代碼或文檔移交不完整，或項(xiàng)目經(jīng)理未及時(shí)通知配置管理員取消權(quán)限，而造成的損失，該責(zé)任完全由項(xiàng)目經(jīng)理承擔(dān)。7) 在配置庫(kù)使用時(shí)，為了避免配置庫(kù)update或commit時(shí)引起沖突，需注意：> 項(xiàng)目經(jīng)理在劃分模塊時(shí)注意每個(gè)人的模塊之間不要重疊。>開發(fā)人員在修改文件之前，養(yǎng)成事先update的習(xí)慣。> 開發(fā)人員注意

15、commit的頻率，盡量及時(shí)commit，規(guī)定每天提交一次。附錄一：配置項(xiàng)命名規(guī)則配置項(xiàng)目命名基本要求：唯一性；可追溯性。1項(xiàng)目名稱命名規(guī)范：要求項(xiàng)目名稱不能太長(zhǎng)，且必須要求使用該項(xiàng)目的英文縮寫命名。項(xiàng)目名稱中最好不出現(xiàn)空格，若有空格，在建立配置庫(kù)時(shí)，配置庫(kù)名中將以“_”來(lái)代替空格。2配置庫(kù)命名配置庫(kù)分為開發(fā)庫(kù)和基線庫(kù)。> 一個(gè)項(xiàng)目的開發(fā)庫(kù)命名為：項(xiàng)目名稱縮寫_dev> 一個(gè)項(xiàng)目總基線庫(kù)的命名為：項(xiàng)目名稱縮寫_bas> 若一個(gè)項(xiàng)目的基線庫(kù)有多個(gè)，可以在其下建立各版本的基線庫(kù)，子基線庫(kù)命名規(guī)則為:項(xiàng)目名稱縮寫+版本號(hào)_bas若一個(gè)項(xiàng)目的開發(fā)庫(kù)有多個(gè),可以在其下建立各版本的開發(fā)庫(kù)

16、,子開發(fā)庫(kù)的命名規(guī)則為:項(xiàng)目名稱縮寫+版本號(hào)_dev3項(xiàng)目各文件夾命名：每個(gè)項(xiàng)目在配置庫(kù)中可以再分為兩個(gè)庫(kù)，開發(fā)庫(kù)（devlib）和基線庫(kù)（baselib）在這兩個(gè)庫(kù)的下面，又可分為如下文件夾：docs、src、test、manager文件夾名字中不允許出現(xiàn)空格。4技術(shù)文檔命名：技術(shù)文檔的標(biāo)識(shí)體現(xiàn)在相應(yīng)文件的封面上，規(guī)范如下：一級(jí)項(xiàng)目名稱+二級(jí)項(xiàng)目名稱三級(jí)項(xiàng)目名稱文檔名稱版本,由開發(fā)人員參照相應(yīng)文檔模板的格式要求，對(duì)技術(shù)文檔進(jìn)行標(biāo)識(shí)。5項(xiàng)目版本編寫規(guī)則：參見(jiàn)軟件版本管理辦法相關(guān)規(guī)定。15附錄二：配置庫(kù)目錄結(jié)構(gòu)每一個(gè)項(xiàng)目的配置庫(kù)可分為devlib（開發(fā)庫(kù)）和baselib（基線庫(kù)），如下為開發(fā)庫(kù)的建庫(kù)樣例，基線庫(kù)與開發(fā)庫(kù)結(jié)構(gòu)相同，但基線庫(kù)和開發(fā)庫(kù)各自獨(dú)立，分開管理。每個(gè)項(xiàng)目的都可以分為如下，并可以根據(jù)實(shí)際情況增減：一級(jí)目錄二級(jí)目錄三級(jí)目錄四級(jí)目錄項(xiàng)目名稱版本號(hào)trunkdocs立項(xiàng)預(yù)研項(xiàng)目計(jì)劃需求分析概要設(shè)計(jì)詳細(xì)設(shè)計(jì)驗(yàn)收產(chǎn)品資料結(jié)項(xiàng)src源代碼demo數(shù)據(jù)庫(kù)發(fā)布包test單元測(cè)試集成測(cè)試系統(tǒng)測(cè)試測(cè)試版本項(xiàng)目名稱版本號(hào)修訂版本號(hào)工具壓力測(cè)試manager規(guī)范組織制度周例會(huì)月度會(huì)議技術(shù)討論其它tag項(xiàng)目名稱版本號(hào)修訂版本號(hào)（其卜為trun