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

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

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

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

4、員與項目經(jīng)理確定配置項，并參考附錄二：配置庫目錄結(jié)構(gòu)，建立配置庫以及配置庫目錄結(jié)構(gòu)；項目經(jīng)理提供配置庫權(quán)限清單（內(nèi)容應包括員工姓名、項目名稱、目錄權(quán)限等），由配置管理員為相關(guān)人員的設置配置權(quán)限。2) 配置庫權(quán)限設置完成之后，由配置管理員將配置庫名稱、訪問路徑、訪問權(quán)限等信息以郵件方式通知各相關(guān)人員；配置庫使用人員以各自的用戶名和密碼進行訪問配置庫。3) 配置庫密碼只能在服務器上設置，如配置庫使用人員密碼遺忘，可以與配置管理員取得聯(lián)系，進行修改密碼。七、配置庫權(quán)限變更管理1) 若在使用配置庫的過程中需要變更配置庫管理權(quán)限，可以由項目配置管理員或項目經(jīng)理以郵件或口頭方式通知配置管理員，配置管理員變

5、更之后，將變更結(jié)果以電子郵件方式通知受影響的人員、項目經(jīng)理、項目配置管理員及其相關(guān)人員。2) 配置管理員根據(jù)配置庫權(quán)限變更頻率，決定每隔一段時間將配置庫權(quán)限清單與各項目經(jīng)理進行審核確認，各項目經(jīng)理審核后，若有權(quán)限需要進行變更，應及時通知配置管理員。八、測試階段配置庫使用流程流程圖如下：1) 配置庫基本結(jié)構(gòu)如“附錄二”所示，通常以項目名稱作為一級目錄，二級目錄包括：trunk、manager、test、tag： 其中“trunk”目錄通常為項目組開發(fā)人員具有讀寫權(quán)限，其他人根據(jù)需求進行相應權(quán)限設置。該目錄包含doc（文檔）、src（代碼）目錄；src下包括四個目錄：demo、源代碼、發(fā)布包、數(shù)據(jù)

6、庫，其中“發(fā)布包”內(nèi)容為空； “manager”目錄通常為研發(fā)中心和項目相關(guān)人員共同使用； “test”目錄為測試人員使用；由于開發(fā)人員需要將發(fā)布包放置在該目錄下，所以開發(fā)人員對該目錄也具有讀寫權(quán)限，但其不允許修改除“測試版本”目錄外的其它目錄的內(nèi)容。 “tag”目錄放置發(fā)布版本，只有項目組開發(fā)人員對其具有讀寫權(quán)限；開發(fā)人員在該目錄下不允許對源代碼等文件進行修改，但需將代碼編譯后放置在“發(fā)布包”目錄下，同時將版本說明等測試人員需要的項目文檔放在該目錄下。注：配置庫權(quán)限根據(jù)實際情況可以進行調(diào)整。2) 以pm_v1.0項目為例說明測試時配置庫使用流程：當項目經(jīng)理確定項目需要提交測試時,由項目開發(fā)人

7、員通過branch/tag的方式將“src”在tag目錄下建立版本分支,例如圖中的pm_v1.0b1001,其下內(nèi)容包括trunk/src下所有內(nèi)容,開發(fā)人員在pm_v1.0b1001下編譯后,將編譯后的文件放在“tag/pm_v1.0b1001/發(fā)布包”目錄下,同時需將版本說明文檔等相關(guān)文檔放在該目錄下。3) “發(fā)布包”中的內(nèi)容完善之后，項目開發(fā)人員將“tag/pm_v1.0b1001/發(fā)布包”在“test/測試版本”目錄下建立tag，tag名稱為“pm_v1.0b1001”（即對應發(fā)布版本名稱），其下內(nèi)容為發(fā)布包中的內(nèi)容。圖一4) 測試人員針對“test/測試版本/pm_v1.0b1001

8、”下的發(fā)布包進行測試。5) 若需發(fā)布新的版本,請重復24步驟。九、基線庫建立流程圖如下：1) 開發(fā)庫經(jīng)測試小組整合測試完成后，配置庫達到一個階段的穩(wěn)定版本，由項目經(jīng)理向研發(fā)中心和配置管理員提出申請，建立基線庫。 2) 由項目經(jīng)理、測試小組負責人確定開發(fā)庫中通過測試的對應版本號，并填寫研發(fā)中心基線庫建立申請表。項目經(jīng)理、測試人員必須保證準備進入基線庫中的所有文檔、代碼、可執(zhí)行程序等相互對應，保證準備入庫資料的完整性和一致性。3) 項目經(jīng)理將研發(fā)中心基線庫建立申請表提交給配置管理員。4) 配置管理員根據(jù)研發(fā)中心基線庫建立申請表中相應內(nèi)容建立基線庫，將正確的版本對應的所有資料納入基線庫管理。5) 基

9、線庫使用者的權(quán)限只能為只讀權(quán)限。使用者向項目經(jīng)理或部門經(jīng)理提出權(quán)限需求，在領(lǐng)導同意之后，配置管理員設置相應權(quán)限，并通知相應人員。十、配置庫備份1) 配置管理員應定期做好配置庫的備份，以防意外引起的服務器上資料的丟失，避免給公司帶來嚴重的損失。2) 配置管理員每周進行硬盤備份一次，每兩個月進行光盤備份一次,備份后的光盤標記上備份日期并附上內(nèi)容清單，移交公司保管。十一、配置庫使用1) 所有立項的項目，都必須申請建立配置庫。開發(fā)過程中所有文檔和代碼必須納入配置庫管理，若因未納入配置庫管理造成的資料丟失或版本差異，其責任皆由開發(fā)人員及項目經(jīng)理承擔。2) 配置庫服務器密碼只有配置管理員和研發(fā)中心掌握，其

10、他人如因特殊原因需要該密碼，必須經(jīng)過研發(fā)中心批準后方能獲取；并在使用完密碼之后，通知研發(fā)中心和配置管理員，配置管理員及時設置新的密碼，以保證服務器資料的安全性和機密性。3) 各配置庫的使用人員必須使用各自的用戶名和密碼進入配置庫，訪問各自的配置庫。各使用人員不得將自己的用戶名和密碼泄漏給其他人員，若因泄露密碼而引起的后果將由泄漏密碼者本人承擔。4) 項目組成員未經(jīng)項目經(jīng)理同意不得更改他人的文檔和代碼。各項目的配置庫用于項目組正式開發(fā)使用，項目組成員不得惡意對其進行修改、刪除、增加等操作；若因?qū)vn工具不熟悉，需要學習，可以向配置管理員提出需求，由配置管理員為其提供可以練習的配置庫。5) 各項

11、目經(jīng)理負責定期檢查配置庫的使用情況，查看是否有員工進行無故刪除或惡意修改文件的行為;并對開發(fā)人員提交的文檔和代碼的及時性、準確性和完整性進行檢查。6) 在研發(fā)人員離職時，由其項目經(jīng)理負責檢查配置庫，檢查該人員提交的代碼或文檔是否完全放入配置庫管理，確認版本和相應文件完整無誤后，項目經(jīng)理在“員工離職申請單”中簽字，該員工方可離職。同時項目經(jīng)理應及時通知配置管理員，取消該人員的所有權(quán)限。若因項目經(jīng)理審核不細致造成的代碼或文檔移交不完整，或項目經(jīng)理未及時通知配置管理員取消權(quán)限，而造成的損失，該責任完全由項目經(jīng)理承擔。7) 在配置庫使用時，為了避免配置庫update或commit時引起沖突，需注意：

12、項目經(jīng)理在劃分模塊時注意每個人的模塊之間不要重疊。 開發(fā)人員在修改文件之前，養(yǎng)成事先update的習慣。 開發(fā)人員注意commit的頻率，盡量及時commit，規(guī)定每天提交一次。附錄一：配置項命名規(guī)則配置項目命名基本要求：唯一性；可追溯性。1項目名稱命名規(guī)范：要求項目名稱不能太長，且必須要求使用該項目的英文縮寫命名。項目名稱中最好不出現(xiàn)空格，若有空格，在建立配置庫時，配置庫名中將以“_”來代替空格。2配置庫命名配置庫分為開發(fā)庫和基線庫。 一個項目的開發(fā)庫命名為：項目名稱縮寫_dev 一個項目總基線庫的命名為：項目名稱縮寫_bas 若一個項目的基線庫有多個,可以在其下建立各版本的基線庫,子基線庫

13、命名規(guī)則為:項目名稱縮寫+版本號_bas 若一個項目的開發(fā)庫有多個,可以在其下建立各版本的開發(fā)庫,子開發(fā)庫的命名規(guī)則為:項目名稱縮寫+版本號_dev3項目各文件夾命名：每個項目在配置庫中可以再分為兩個庫，開發(fā)庫（devlib）和基線庫（baselib）在這兩個庫的下面，又可分為如下文件夾：docs、src、test、manager 文件夾名字中不允許出現(xiàn)空格。4技術(shù)文檔命名：技術(shù)文檔的標識體現(xiàn)在相應文件的封面上，規(guī)范如下：一級項目名稱+二級項目名稱三級項目名稱文檔名稱版本, 由開發(fā)人員參照相應文檔模板的格式要求，對技術(shù)文檔進行標識。5項目版本編寫規(guī)則：參見軟件版本管理辦法相關(guān)規(guī)定。附錄二：配置

14、庫目錄結(jié)構(gòu)每一個項目的配置庫可分為devlib（開發(fā)庫）和baselib（基線庫），如下為開發(fā)庫的建庫樣例，基線庫與開發(fā)庫結(jié)構(gòu)相同，但基線庫和開發(fā)庫各自獨立，分開管理。每個項目的都可以分為如下，并可以根據(jù)實際情況增減：一級目錄二級目錄三級目錄四級目錄項目名稱_版本號trunkdocs立項預研項目計劃需求分析概要設計詳細設計驗收產(chǎn)品資料結(jié)項src源代碼demo數(shù)據(jù)庫發(fā)布包test單元測試集成測試系統(tǒng)測試測試版本項目名稱_版本號_修訂版本號工具壓力測試manager規(guī)范組織制度周例會月度會議技術(shù)討論其它tag項目名稱_版本號_修訂版本號(其下為trunk/src目錄下所有內(nèi)容)附錄三：基線庫建立申請表研發(fā)中心基線庫建立申請表項目名稱項