軟件項(xiàng)目的文檔與配置管理

1、第三章 軟件項(xiàng)目的文檔與配置管理,谷瑞 東南大學(xué)軟件學(xué)院,3.1 軟件工程文檔概述3.2 文檔的分類與編制時間3.3 文檔的管理3.4 配置管理的基本概念3.5 配置管理的過程3.6 配置管理的組織與實(shí)施,,,一個程序員的懺悔錄 曾經(jīng)有一個很好的文檔配置管理工具在我面前，我沒有理睬，直到版本混亂的時候才后悔莫及，工作中最大的痛苦莫過于此，如果上天再給我一次機(jī)會的話，我向?qū)λf三個字：我要你。如果非得加一個期限的話，我希望是

2、一輩子。,3.1 軟件項(xiàng)目文檔管理概述,項(xiàng)目文檔概述軟件項(xiàng)目文檔是IT軟件項(xiàng)目開發(fā)中的重要組成部分項(xiàng)目文檔作用能作為開發(fā)組員之間交流溝通的媒介能為軟件項(xiàng)目的維護(hù)工程師提供有關(guān)信息系統(tǒng)的資料和知識庫能為項(xiàng)目管理者提供項(xiàng)目計劃、預(yù)算、開發(fā)進(jìn)度等各方面的信息能作為最終用戶或管理員的用戶手冊，使用戶知道如何使用、維護(hù)及管理系統(tǒng),3.1 軟件項(xiàng)目文檔管理概述,文檔的分類——按照文檔的產(chǎn)生和使用范圍，文檔可分為三類：開發(fā)文檔作為軟

3、件開發(fā)人員前一階段的工作體現(xiàn)和后一階段的工作依據(jù)管理文檔由軟件開發(fā)人員制定的需提交給相關(guān)人員的一些工作計劃或工作報告用戶文檔是軟件開發(fā)人員為用戶準(zhǔn)備的有關(guān)該軟件使用、操作、維護(hù)的資料,3.2 文檔編制時間表,階段,文檔,文檔編制時間表,3.2 文檔編制時間表,項(xiàng)目組人員與文檔編制表,文檔,用戶,3.3 文檔的管理與維護(hù),文檔的管理在軟件生存周期中，各種文檔作為半成品或成品，會不斷生成、修改或補(bǔ)充。一般的，文檔的管理包括：應(yīng)

4、該編制哪些文檔，其詳盡程度如何審查和批準(zhǔn)的負(fù)責(zé)人和時間進(jìn)度安排在開發(fā)期間內(nèi)各文檔的維護(hù)、修改和管理負(fù)責(zé)人,3.4 配置管理的基本概念,軟件項(xiàng)目開發(fā)中是否遇到如下的問題？,開發(fā)人員使用錯誤的版本修改程序開發(fā)人員未經(jīng)授權(quán)修改代碼或文檔,或修改的結(jié)果不能及時反映到各個相關(guān)部分；人員流動，交接工作不徹底造成軟件關(guān)鍵部件遺失；已修復(fù)的Bug在新版本中出現(xiàn),找不到某個文件的歷史版本無法重新編譯某個歷史版本，使維護(hù)工作十分困難；因協(xié)同開

5、發(fā)中，或者異地開發(fā)，版本變更混亂導(dǎo)致整個項(xiàng)目失?。弧?…,——軟件項(xiàng)目進(jìn)行中面臨的一個主要問題是持續(xù)不斷的變化；配置管理是有效管理變更的手段，它貫穿著幾乎軟件的整個生命周期。,3.4 配置管理的基本概念,配置管理軟件配置管理(Software Configuration Management，SCM)是對產(chǎn)品進(jìn)行標(biāo)志、存儲和控制，以維護(hù)其完整性、可追溯性以及正確性，它為軟件開發(fā)提供了一套管理辦法和活動原則。配置管理作用記錄軟件

6、產(chǎn)品的演化過程確保軟件開發(fā)者在軟件生命周期中的各個階段都能得到精確的產(chǎn)品配置。最終保證軟件產(chǎn)品的完整性、一致性、追朔性、可控性,3.4 配置管理的基本概念,軟件配置項(xiàng)軟件配置項(xiàng)：凡是納入配置管理范疇的工作成果統(tǒng)稱為配置項(xiàng)（Configuration Item，CI）。配置項(xiàng)主要有兩大類：屬于產(chǎn)品組成部分的工作成果，例如源代碼、需求文檔、設(shè)計文檔、測試用例等等。在管理過程中產(chǎn)生的文檔，例如各種計劃、狀態(tài)報告等等，這些文檔雖然不是

7、產(chǎn)品的組成部分，但是值得保存。,每個配置項(xiàng)的主要屬性有：名稱、標(biāo)識符、文件狀態(tài)、版本、作者、日期等。,3.4 配置管理的基本概念,配置項(xiàng)狀態(tài)變遷——配置項(xiàng)剛建立時其狀態(tài)為“草稿”；配置項(xiàng)通過評審（或?qū)徟┖?，其狀態(tài)變?yōu)椤罢桨l(fā)布”,3.4 配置管理的基本概念,基線——基線是軟件生存周期中的一個特定點(diǎn)，其作用是把開發(fā)階段的工作劃更加明確化、使本來連續(xù)的工作在這點(diǎn)斷開，以便于檢查和評價階段成果,,圖：軟件開發(fā)中的基線,3.4 軟件配置管

8、理概述,版本與版本控制——軟件配置是一個動態(tài)的概念，它一方面隨著軟件生存周期向前推進(jìn)，另一方面隨時會有新的變種出現(xiàn),圖：版本演變與變種,3.4 配置管理的基本概念,版本與版本控制軟件的每一個版本都是源代碼、文檔及數(shù)據(jù)以及相關(guān)的系統(tǒng)環(huán)境的一個收集，且各個版本都可能由不同的變種組成。版本控制的目的是按照一定的規(guī)則保存配置項(xiàng)的所有版本，避免發(fā)生版本丟失或混淆等現(xiàn)象，并且可以快速準(zhǔn)確地查找到配置項(xiàng)的任何版本。,3.4 配置管理的基本概念

9、,版本控制規(guī)則處于“草稿”狀態(tài)的配置項(xiàng)的版本號格式為：0.YZ YZ數(shù)字范圍為01-99處于“正式發(fā)布”狀態(tài)的配置項(xiàng)的版本號格式為：X.Y X為主版本號，取值范圍為1-9。Y為次版本號，取值范圍為1-9處于“正在修改”狀態(tài)的配置項(xiàng)的版本號格式為：X.YZ配置項(xiàng)正在修改時，一般只增大Z值，X.Y值保持不變,3.4 配置管理的基本概念,配置管理委員會 配置管理委員會(Software Configuration Contr

10、ol Board，SCCB)是實(shí)現(xiàn)有序、及時和正確處理軟件配置項(xiàng)的基本機(jī)制。主要負(fù)責(zé)評估變更批準(zhǔn)變更申請在生存期內(nèi)規(guī)范變更申請流程對變更進(jìn)行反饋與項(xiàng)目管理層溝通,3.5 軟件項(xiàng)目配置管理過程,配置管理基本活動配置管理計劃 配置項(xiàng)標(biāo)志 配置項(xiàng)控制 狀態(tài)狀況報告 配置項(xiàng)審核,配置管理過程 配置項(xiàng)標(biāo)識、跟蹤配置管理環(huán)境建立基線變更管理基線審核配置狀態(tài)統(tǒng)計配置管理計劃,—— 配置管理過程圍繞配置管理的5項(xiàng)活動進(jìn)

11、行,3.5 軟件項(xiàng)目配置管理過程,項(xiàng)目配置管理過程 配置管理計劃就是確定軟件配置管理的解決方案，一個關(guān)鍵任務(wù)是確定要控制哪些文檔。配置項(xiàng)標(biāo)志、跟蹤一個項(xiàng)目通常會生成很多的過程文件，并經(jīng)歷不同的階段和版本,3.5 軟件項(xiàng)目配置管理過程,項(xiàng)目配置管理過程配置管理環(huán)境建立 —— 建立配置管理庫，簡稱配置庫 。軟件配置管理庫是用來存儲所有基線配置項(xiàng)及相關(guān)文件的等內(nèi)容的系統(tǒng)，是在軟件產(chǎn)品的整個生存期中建立和維護(hù)軟件產(chǎn)品完整性

12、的主要手段。開發(fā)庫受控庫產(chǎn)品庫,3.5 軟件項(xiàng)目配置管理過程,項(xiàng)目配置管理過程配置管理環(huán)境建立 受控操作 :從受控庫導(dǎo)出的文件自動被鎖定直到文件重新被導(dǎo)入，一個版本號自動與新版本文件相關(guān)聯(lián)。配置庫中文件不能更改，任何更改都被視為創(chuàng)建了一個新版本文件。,3.5 軟件項(xiàng)目配置管理過程,項(xiàng)目配置管理過程基線變更管理 ——項(xiàng)目基線（配置項(xiàng)）可能由于種種原因會發(fā)生變更，如：客戶需求變化、進(jìn)度變更、成本變更、產(chǎn)品環(huán)境變化等

13、。,3.5 軟件項(xiàng)目配置管理過程,項(xiàng)目配置管理過程基線變更管理變更請求,3.5 軟件項(xiàng)目配置管理過程,項(xiàng)目配置管理過程基線變更管理變更評估,3.5 軟件項(xiàng)目配置管理過程,項(xiàng)目配置管理過程基線變更管理變更批準(zhǔn)或拒絕,3.5 軟件項(xiàng)目配置管理過程,項(xiàng)目配置管理過程基線變更管理變更批準(zhǔn)或拒絕,2.5 軟件項(xiàng)目配置管理過程,項(xiàng)目配置管理過程配置審核——配置審核作為變更控制的補(bǔ)充手段，目的是為了確保某一變更請求已被確切實(shí)現(xiàn)。配

14、置審核主要包括兩方面的內(nèi)容：配置管理活動審核基線審核,3.5 軟件項(xiàng)目配置管理過程,項(xiàng)目配置管理過程 狀態(tài)報告——定期檢測軟件配置管理系統(tǒng)的運(yùn)行情況以及配置項(xiàng)本身的變更歷史記錄，并且將這些結(jié)果以報告的形式給出。,3.6 配置管理組織與實(shí)施,配置管理組織,3.6 配置管理組織與實(shí)施,配置管理實(shí)施——主要包括的活動,確定初始基線——由SCCB確定研發(fā)活動的初始基線；配置庫管理——配置人員根據(jù)軟件配置管理規(guī)劃設(shè)立配置庫和工作空間，為

15、執(zhí)行軟件配置管理做好準(zhǔn)備，并定期執(zhí)行備份和清理工作；授權(quán)開發(fā)——開發(fā)人員按照統(tǒng)一的軟件配置管理策略，根據(jù)獲得授權(quán)的資源進(jìn)行項(xiàng)目研發(fā)工作；,集成——系統(tǒng)集成人員按照項(xiàng)目進(jìn)度集成組內(nèi)開發(fā)人員的工作成果，構(gòu)建系統(tǒng)，推進(jìn)版本演進(jìn)；管理基線——SCCB根據(jù)項(xiàng)目的進(jìn)展情況，并適時地建立基線，批準(zhǔn)基線變更，保證開發(fā)和維護(hù)工作有序地進(jìn)行；產(chǎn)品開發(fā)——系統(tǒng)集成人員進(jìn)行產(chǎn)品集成，由SCCB批準(zhǔn)，進(jìn)行發(fā)布。,3.6 配置管理組織與實(shí)施,配置管理工具 —

16、—分為3個級別第一個級別 版本控制工具，是入門級的工具。例如，CVS、Visual Source Safe。第二個級別 項(xiàng)目級配置管理工具，適合管理中小型的項(xiàng)目，在版本管理的基礎(chǔ)上增加變更控制、狀態(tài)統(tǒng)計的功能。例如ClearCase、ClearQuest 、PVCS。 第三個級別 企業(yè)級配置管理工具，在實(shí)現(xiàn)傳統(tǒng)意義的配置管理的基礎(chǔ)上又具有比較強(qiáng)的過程管理功能。例如， Harvest,3.6 配置管理組織與實(shí)施,配置管理