《配置管理手冊》

1、配置管理手冊version 1.0 北京紫光捷通公司工程軟件部目錄1 引言 . 31.1 編寫目的 . 31.2 閱讀指導(dǎo) . 32 基本約定 . 32.1 定義 . 32.2 適用的標(biāo)準(zhǔn)、條例和約定. 52.2.1 文檔命名規(guī)范 . 52.2.2 測試用例命名規(guī)范. 62.2.3 整理 9001 文件夾 . 62.3 接口控制 . 62.4 參考資料 . 73 配置環(huán)境 . 73.1 公網(wǎng) common 開發(fā)庫 . 73.2 部門 deployment 受控庫 . 84 基本流程 . 84.1 總體流程 . 84.1.1 開發(fā)庫流程 . 94.1.2 受控庫流程 . 10 4.2 崗位工作流

2、程. 11 4.2.1 產(chǎn)品經(jīng)理工作流程. 11 4.2.2 開發(fā)工程師 . 11 4.2.2.1 開發(fā)工程師工作流程. 11 4.2.2.2 開發(fā)工程師文件夾管理. 12 4.2.3 系統(tǒng)工程師工作流程. 13 5 記錄的收集、維護(hù)和保存. 13 1 引言1.1 編寫目的在軟件產(chǎn)品的生命周期中，要經(jīng)歷需求分析，設(shè)計，編碼，測試，提交，維護(hù)等一系列過程。在這個過程中，軟件產(chǎn)品要經(jīng)歷無數(shù)次的變更，如果不能很好地標(biāo)識變更，控制變更，確保變更的實現(xiàn)，項目就會陷入混亂，因此，制訂本配置管理計劃的目的，就是從多個方面描述如何進(jìn)行配置管理，并通過配置管理保證項目不會陷入混亂。1.2 閱讀指導(dǎo)本手冊主要分為

3、五部分：引言、基本約定、配置環(huán)境、基本流程、記錄的收集、維護(hù)和保存。第二部分 基本約定 主要介紹了配置管理中一些基本的約定，包括定義、適用標(biāo)準(zhǔn)、接口控制 和參考資料。第三部分 配置環(huán)境 分別對公網(wǎng)和部門的軟件庫配置信息進(jìn)行了描述。第四部分 基本流程 是本手冊的重點，分為 總體流程 和崗位流程 ，建議根據(jù)具體的崗位有側(cè)重點的進(jìn)行閱讀。第五部分 記錄的收集、維護(hù)和保存對項目產(chǎn)生的代碼、文檔等的維護(hù)、保存進(jìn)行了說明。2 基本約定2.1 定義本計劃中用到的一些術(shù)語的定義按gb/t 11457 和 gb/t 12504。配置項（configuration item） ：就是指在開發(fā)過程中所有的需要記錄歷

4、史行為的半成品和成品。在開發(fā)過程中，無論文檔（開發(fā)計劃，需求分析，概要設(shè)計，詳細(xì)設(shè)計，測試計劃，測試用例，測試報告。 。 。 ） ， 源代碼（c/pascal源程序，數(shù)據(jù)庫建立腳本，基本代碼數(shù)據(jù)。 。 。 ） ，測試代碼，發(fā)行版本（可脫離源代碼直接運行的程序） ，支持平臺（操作系統(tǒng)，數(shù)據(jù)庫系統(tǒng)） ，驅(qū)動外設(shè)，都存在著變化的可能和必然性， 這些都被認(rèn)為是配置項。 配置管理的第一步就應(yīng)當(dāng)標(biāo)識出項目中應(yīng)當(dāng)管理的配置項。基線（ baseline ） ：我們以前稱為里程碑（ milestone ） 。基線的含義是軟件開發(fā)的一個預(yù)定義的程度或階段。定義基線的好處是保證開發(fā)能夠漸進(jìn)，可靠的推進(jìn)。通過基線的劃

5、分能夠?qū)㈤_發(fā)的過程透明化，有利于控制開發(fā)的風(fēng)險（小階段的進(jìn)度與資源都比較好控制） 。由于基線代表軟件開發(fā)達(dá)到一定的程度，因此通過基線必須通過檢查列表（checklist ） 。在 iso9001中就是要做階段評審（立項評審，軟件定義評審，需求分析評審，概要設(shè)計評審，詳細(xì)設(shè)計評審，編碼測試評審，組裝測試評審，安裝驗收評審，運行維護(hù)評審）。在iso9001 中主要明確 3 種基線（功能基線，指派基線，產(chǎn)品基線），我們可以根據(jù)項目的特性在每個階段插入更多的子基線（如在開發(fā)階段中插入3 個子基線） 。軟件庫（softbank ） ：指集中保存上述配置項的數(shù)據(jù)庫。應(yīng)當(dāng)指出該軟件庫保存所有配置項的所有歷史

6、修改記錄，因此通常有相應(yīng)的配置管理客戶端輔助工作。iso9001規(guī)定軟件開發(fā)必須存在3 個不同的軟件庫，分別用于不同的階段和目的：研發(fā)庫，受控庫和產(chǎn)品庫。開發(fā)庫（developing softbank） ：保存處于開發(fā)階段的所有配置項的歷史信息。這個庫放在公網(wǎng)上，名稱是common 。這里用于臨時存放所有正在開發(fā)的代碼和文檔等。開發(fā)人員可對其進(jìn)行檢入、檢出操作。一個階段的開發(fā)工作完畢后，此開發(fā)庫將被清空。受控庫（undercontrolled softbank） ：受控庫由配置管理員統(tǒng)一管理，主要用于軟件版本的維護(hù)、升級及改進(jìn)。一個階段的開發(fā)工作完成后，配置項即轉(zhuǎn)入受控庫，開發(fā)人員不可自行修改

7、已入庫的配置項。出庫登記（ check out ） ：在配置管理中，為了保證在軟件庫中的成品/半成品不會因為多人同時開發(fā)而變的不一致，同時為了跟蹤變化本身， 每個開發(fā)人員在對軟件庫中的產(chǎn)品做出改動之前，必須進(jìn)行check out 操作。通過這個操作，開發(fā)人員就獲得了一個中心產(chǎn)品在本地的私有拷貝，隨后的所有編輯都是針對本地的私有拷貝進(jìn)行的。入庫登記（ check in） ：如果開發(fā)人員完成了編輯和調(diào)試工作，希望將成果加入或刷新中心庫，則需要進(jìn)行入庫登記。通過入庫登記，配置管理工具就能夠記錄產(chǎn)品變化的歷史，并以一種高效的方式保存所有的歷史記錄。個人工作區(qū)（ working folder ） ：從中

8、心軟件庫中通過check out 操作，開發(fā)人員希望的產(chǎn)品代碼或文檔等，就進(jìn)入開發(fā)人員的個人工作區(qū)。版本控制（ version control ） ：在配置管理中，版本的概念不同與一般（如 3.2.0023） 。只要進(jìn)行了一次check in，就產(chǎn)生了該配置項的一個新的版本。在配置管理工具中，通常以整型值作為版本號。在中心庫中，能夠保存所有配置項的所有版本，當(dāng)然首先開發(fā)人員必須遵守check in/out 的規(guī)范。我們通常所說的版本，可以使用給某個配置項版本加標(biāo)簽的方法標(biāo)識。標(biāo)簽（label ） ：在配置管理工具中，使用標(biāo)簽來標(biāo)明配置項或項目的一個有意義的名稱，如版本3.1.2，這個標(biāo)簽并不一

9、定代表其中文件的真實版本號。2.2 適用的標(biāo)準(zhǔn)、條例和約定在配置管理過程中應(yīng)該遵守如下標(biāo)準(zhǔn)、條例和約定：a 軟件開發(fā)庫、軟件受控庫與軟件產(chǎn)品庫的操作規(guī)程與管理規(guī)程；b 系統(tǒng)、子系統(tǒng)、模塊和程序單元的命名約定；c 文檔和測試用例的命名和管理規(guī)程。這引起命名約定、操作規(guī)程與管理規(guī)程應(yīng)由項目技術(shù)組負(fù)責(zé)制訂，并應(yīng)認(rèn)真聽取各子系統(tǒng)項目負(fù)責(zé)人的意見，最后報項目核心組審批。在執(zhí)行過程中，如果發(fā)現(xiàn)某些條款需要修改，必須經(jīng)項目核心組批準(zhǔn)，同時進(jìn)行修改記錄。2.2.1 文檔命名規(guī)范文檔命名采用如右方式：a-b-c-xx 。a部分表示公司名稱（紫光捷通即用jt表示） ；b部分表示部門名稱（工程軟件部用syf表示）

10、；c部分用項目漢語拼音打頭字母表示（如：菏關(guān)項目用hg表示） ；xx 部分為文檔編號，可參考具體項目的軟件質(zhì)量保證計劃，里面詳細(xì)列出編號與文檔的對應(yīng)關(guān)系。（如： jt-syf-hg-01可以用來表示菏關(guān)項目的需求分析文件）2.2.2 測試用例命名規(guī)范測試用例命名采用如下方式：a-b-cs-d-xx 。a部分表示公司名稱（紫光捷通即用jt表示） ；b部分表示部門名稱（工程軟件部用syf表示） ；cs 代碼表示測試用例；d 部分用項目漢語拼音打頭字母表示（如：菏關(guān)項目用hg 表示） ；xx 部分為測試用例編號， 測試主管負(fù)責(zé)對測試用例進(jìn)行編號，并整理出測試用例編號與名稱對應(yīng)表。（如： jt-syf

11、-cs-hg-01可以用來表示菏關(guān)項目的第一個測試用例）2.2.3 整理 9001 文件夾在整理 9001 文檔夾時 , 可以不必打印出來，只打印封皮，在封皮上標(biāo)明對應(yīng)文檔的最新版本號和在軟件庫中的編號就可以。如：山東菏關(guān)公共 需求分析軟件需求規(guī)格書 .doc 2.3 接口控制對各類接口進(jìn)行嚴(yán)格、合理的控制，是軟件配置管理中最重要的任務(wù)之一。整個軟件項目及其各子系統(tǒng)都必須進(jìn)行嚴(yán)格的控制。在工程化軟件系統(tǒng)中，主要的接口有如下五類：a 用戶界面：用戶界面是指各子系統(tǒng)與設(shè)計人員、用戶或維護(hù)人員之間的操作約定。同時還指實現(xiàn)這些操作約定的物理部件的功能與性能特性。b 系統(tǒng)內(nèi)部接口：系統(tǒng)內(nèi)部接口是指各子系

12、統(tǒng)在集成為一個總的軟件系統(tǒng)時的各種連接約定。c 標(biāo)準(zhǔn)程序接口：標(biāo)準(zhǔn)程序接口是指各應(yīng)用子系統(tǒng)與標(biāo)準(zhǔn)子程序庫（包括宿主計算機(jī)系統(tǒng)已有的庫程序）之間的調(diào)用約定。d 設(shè)備接口：設(shè)備接口是指各子系統(tǒng)與各種設(shè)備（包括終端和其他各種輸入/ 輸出設(shè)備）之間的連接約定。e 軟件接口：軟件接口是指各個子系統(tǒng)與宿主計算機(jī)上的系統(tǒng)軟件以及與調(diào)用本軟件的其它軟件系統(tǒng)之間的連接約定。以上五類接口是一個軟件系統(tǒng)各項配置的重要組成部分。對接口修改進(jìn)行合理的控制，是軟件配置管理的重要任務(wù)之一。這五類接口都涉及到監(jiān)控軟件系統(tǒng)的全局，因此，當(dāng)要求對這五類接口中的任一類接口進(jìn)行修改時，必須經(jīng)項目核心組批準(zhǔn)，同時進(jìn)行修改記錄。2.4

13、參考資料gb/t 11457 軟件工程術(shù)語gb 8566 計算機(jī)軟件開發(fā)規(guī)范gb 8567 計算機(jī)軟件產(chǎn)品開發(fā)文件編制指南gb/t 12504 計算機(jī)軟件質(zhì)量保證計劃規(guī)范gb/t 12505 計算機(jī)軟件配置管理計劃規(guī)范cadcsc 軟件質(zhì)量保證計劃3 配置環(huán)境3.1 公網(wǎng) common開發(fā)庫服務(wù)器 ，端口號 60012。用戶名 / 密碼： 均為本人姓名漢語拼音全稱，建議登陸后及時修改密碼。權(quán)限： 部門成員擁有本人工作目錄的讀寫及修改權(quán)限，對公共文件夾可讀，其他人的目錄不可訪問。注：初次使用需導(dǎo)入個人密鑰，tools-import encryption key導(dǎo)入姓名.iky 。3.2 部門 d

14、eployment受控庫ip 192.168.1.9 ，端口號 8888。用戶名 / 密碼： 均為本人姓名漢語拼音全稱，建議登陸后及時修改密碼。權(quán)限： 產(chǎn)品經(jīng)理及配置管理員擁有讀寫權(quán)限。其他人員對該數(shù)據(jù)庫只讀。4 基本流程4.1 總體流程配置管理工作貫穿于各項目組成員， 為方便各項目組成員團(tuán)隊合作以及配合，對本地系統(tǒng)文件夾以及軟件庫進(jìn)行統(tǒng)一約定。在軟件工程化生產(chǎn)的各個階段中，與本階段的階段產(chǎn)品有關(guān)的全部信息在軟件開發(fā)庫存放，與前面各個階段的階段產(chǎn)品有關(guān)的信息則在軟件受控庫存放。在研制與開發(fā)階段的階段產(chǎn)品的過程中，開發(fā)者和開發(fā)小組長有權(quán)對本階段的階段產(chǎn)品作必要的修改；但是如果開發(fā)者或開發(fā)小組長認(rèn)

15、為有必要更新前面有關(guān)階段的階段產(chǎn)品時，就必須通過項目的配置管理小組辦理正規(guī)的審批手續(xù)。因此，軟件開發(fā)庫屬開發(fā)這個階段產(chǎn)品的開發(fā)者管理，而軟件受控庫由項目的配置管理小組管理。軟件經(jīng)過組裝與系統(tǒng)測試后，應(yīng)該送入軟件產(chǎn)品庫，如欲對其修改，必須經(jīng)軟件配置管理小組研究同意，然后報項目核心組組長批準(zhǔn)，并同步進(jìn)行修改記錄。4.1.1 開發(fā)庫流程公網(wǎng)開發(fā)庫 （common）數(shù)據(jù)庫的為臨時文件夾， 下設(shè)兩個目錄： 分別是 work以及 公共文件夾 。 公共文件夾 只用于臨時存放項目文檔（任何人提出對項目文檔的需求后，配置管理員會將把該文檔放至此文件夾，供大家下載取用）；work目錄下設(shè)以開發(fā)工程師姓名命名的文件

16、夾，開發(fā)工程師將代碼和文檔放在里面，專職配置管理員會對大家的代碼提交情況進(jìn)行記錄及考核。（詳見 開發(fā)工程師工作流程）4.1.2 受控庫流程部門內(nèi)部受控庫（ deployment）主要由配置管理員進(jìn)行管理。產(chǎn)品經(jīng)理及配置管理員可以訪問。開發(fā)工作完畢后，配置管理員把開發(fā)庫內(nèi)容移至受控庫，并下載數(shù)據(jù)到測試計算機(jī)交由測試人員進(jìn)行測試。由測試主管提交測試結(jié)果給開發(fā)工程師并對開發(fā)過程進(jìn)行跟蹤。測試完成后，將代碼存入受控庫進(jìn)行版本管理。4.2 崗位工作流程4.2.1 產(chǎn)品經(jīng)理工作流程產(chǎn)品經(jīng)理的工作流程見下圖：4.2.2 開發(fā)工程師4.2.2.1 開發(fā)工程師工作流程開發(fā)工程師出庫入庫工作流程如下圖，分別在公網(wǎng)

17、（common）和本地建立工作文件夾，建立本項目目錄樹，建立須嚴(yán)格按照個人文件夾管理規(guī)范執(zhí)行。每個項目開始之前，應(yīng)對本人工作進(jìn)行計劃，主要包括本人工作推進(jìn)時間安排，將本項目計劃一并放入該項目文件夾中。開發(fā)過程中，需每天進(jìn)行代碼提交工作（相鄰兩次提交時間最長不得超過3天） ，專職配置管理員將不定期提醒開發(fā)工程師及時提交工作成果，并對提交情況進(jìn)行記錄、統(tǒng)計，此統(tǒng)計結(jié)果將作為年終考核重點之一。開發(fā)工程師可隨時向配置管理員索要本人本年度代碼、文檔提交情況記錄。4.2.2.2 開發(fā)工程師文件夾管理公網(wǎng)（ common ）庫中，個人文件夾內(nèi)目錄須按照下圖建立：4.2.3 系統(tǒng)工程師工作流程系統(tǒng)工程師主要負(fù)責(zé)軟件測試、安裝調(diào)試及后期維護(hù)工作?；竟ぷ髁鞒桃娤聢D：5 記錄的收集、維護(hù)和保存在本項目及其所屬的各個子系統(tǒng)的研制與開發(fā)期間，要進(jìn)行各種軟件配置管理活動。準(zhǔn)確記錄、及時分析并妥善存放有關(guān)這些活動的記錄，對這些軟件的下沉運行與維護(hù)工作十分有利。在軟件配置管理小組中，應(yīng)有專人負(fù)責(zé)收集、匯總與保存這些記錄。a 基礎(chǔ)上組裝系統(tǒng)、各個子系統(tǒng)、專用支持軟件及選用軟件的功能基線、指派基線與產(chǎn)品基線要送入硬盤或磁帶，至少必須一式兩份且存放在兩個不同的地點。這些記錄應(yīng)該每 6個月拷貝一次，以免意外損傷