第三章 軟件文檔與配置管理

第三章

軟件項(xiàng)目的文檔與配置管理谷瑞東南大學(xué)軟件學(xué)院3.1軟件工程文檔概述3.2文檔的分類與編制時(shí)間3.3文檔的管理3.4配置管理的基本概念3.5配置管理的過程3.6配置管理的組織與實(shí)施一個(gè)程序員的懺悔錄

曾經(jīng)有一個(gè)很好的文檔配置管理工具在我面前，我沒有理睬，直到版本混亂的時(shí)候才后悔莫及，工作中最大的痛苦莫過于此，如果上天再給我一次機(jī)會(huì)的話，我向?qū)λf三個(gè)字：我要你。如果非得加一個(gè)期限的話，我希望是一輩子。3.1軟件項(xiàng)目文檔管理概述項(xiàng)目文檔概述軟件項(xiàng)目文檔是IT軟件項(xiàng)目開發(fā)中的重要組成部分項(xiàng)目文檔作用能作為開發(fā)組員之間交流溝通的媒介能為軟件項(xiàng)目的維護(hù)工程師提供有關(guān)信息系統(tǒng)的資料和知識(shí)庫(kù)能為項(xiàng)目管理者提供項(xiàng)目計(jì)劃、預(yù)算、開發(fā)進(jìn)度等各方面的信息能作為最終用戶或管理員的用戶手冊(cè)，使用戶知道如何使用、維護(hù)及管理系統(tǒng)3.1軟件項(xiàng)目文檔管理概述文檔的分類——按照文檔的產(chǎn)生和使用范圍，文檔可分為三類：開發(fā)文檔作為軟件開發(fā)人員前一階段的工作體現(xiàn)和后一階段的工作依據(jù)管理文檔由軟件開發(fā)人員制定的需提交給相關(guān)人員的一些工作計(jì)劃或工作報(bào)告用戶文檔是軟件開發(fā)人員為用戶準(zhǔn)備的有關(guān)該軟件使用、操作、維護(hù)的資料3.2文檔編制時(shí)間表可行性研究需求分析軟件設(shè)計(jì)編碼與單元測(cè)試集成與系統(tǒng)測(cè)試運(yùn)行維護(hù)可行性分析報(bào)告項(xiàng)目開發(fā)計(jì)劃軟件需求說明書數(shù)據(jù)庫(kù)要求說明書測(cè)試計(jì)劃概要設(shè)計(jì)說明書詳細(xì)設(shè)計(jì)說明書用戶手冊(cè)操作手冊(cè)測(cè)試分析報(bào)告開發(fā)進(jìn)度月報(bào)項(xiàng)目開發(fā)總結(jié)程序維護(hù)手冊(cè)階段文檔文檔編制時(shí)間表3.2文檔編制時(shí)間表管理人員開發(fā)人員維護(hù)人員用戶可行性分析報(bào)告項(xiàng)目開發(fā)計(jì)劃軟件需求說明書數(shù)據(jù)庫(kù)要求說明書測(cè)試計(jì)劃概要設(shè)計(jì)說明書詳細(xì)設(shè)計(jì)說明書用戶手冊(cè)操作手冊(cè)測(cè)試分析報(bào)告開發(fā)進(jìn)度月報(bào)項(xiàng)目開發(fā)總結(jié)程序維護(hù)手冊(cè)項(xiàng)目組人員與文檔編制表文檔用戶3.3文檔的管理與維護(hù)文檔的管理在軟件生存周期中，各種文檔作為半成品或成品，會(huì)不斷生成、修改或補(bǔ)充。一般的，文檔的管理包括：應(yīng)該編制哪些文檔，其詳盡程度如何審查和批準(zhǔn)的負(fù)責(zé)人和時(shí)間進(jìn)度安排在開發(fā)期間內(nèi)各文檔的維護(hù)、修改和管理負(fù)責(zé)人3.4配置管理的基本概念軟件項(xiàng)目開發(fā)中是否遇到如下的問題？開發(fā)人員使用錯(cuò)誤的版本修改程序開發(fā)人員未經(jīng)授權(quán)修改代碼或文檔,或修改的結(jié)果不能及時(shí)反映到各個(gè)相關(guān)部分；人員流動(dòng)，交接工作不徹底造成軟件關(guān)鍵部件遺失；已修復(fù)的Bug在新版本中出現(xiàn)找不到某個(gè)文件的歷史版本無(wú)法重新編譯某個(gè)歷史版本，使維護(hù)工作十分困難；因協(xié)同開發(fā)中，或者異地開發(fā)，版本變更混亂導(dǎo)致整個(gè)項(xiàng)目失??；……——軟件項(xiàng)目進(jìn)行中面臨的一個(gè)主要問題是持續(xù)不斷的變化；配置管理是有效管理變更的手段，它貫穿著幾乎軟件的整個(gè)生命周期。3.4配置管理的基本概念配置管理軟件配置管理(SoftwareConfigurationManagement，SCM)是對(duì)產(chǎn)品進(jìn)行標(biāo)志、存儲(chǔ)和控制，以維護(hù)其完整性、可追溯性以及正確性，它為軟件開發(fā)提供了一套管理辦法和活動(dòng)原則。配置管理作用記錄軟件產(chǎn)品的演化過程確保軟件開發(fā)者在軟件生命周期中的各個(gè)階段都能得到精確的產(chǎn)品配置。最終保證軟件產(chǎn)品的完整性、一致性、追朔性、可控性3.4配置管理的基本概念軟件配置項(xiàng)軟件配置項(xiàng)：凡是納入配置管理范疇的工作成果統(tǒng)稱為配置項(xiàng)（ConfigurationItem，CI）。配置項(xiàng)主要有兩大類：屬于產(chǎn)品組成部分的工作成果，例如源代碼、需求文檔、設(shè)計(jì)文檔、測(cè)試用例等等。在管理過程中產(chǎn)生的文檔，例如各種計(jì)劃、狀態(tài)報(bào)告等等，這些文檔雖然不是產(chǎn)品的組成部分，但是值得保存。每個(gè)配置項(xiàng)的主要屬性有：名稱、標(biāo)識(shí)符、文件狀態(tài)、版本、作者、日期等。3.4配置管理的基本概念配置項(xiàng)狀態(tài)變遷——配置項(xiàng)剛建立時(shí)其狀態(tài)為“草稿”；配置項(xiàng)通過評(píng)審（或?qū)徟┖螅錉顟B(tài)變?yōu)椤罢桨l(fā)布”3.4配置管理的基本概念基線——基線是軟件生存周期中的一個(gè)特定點(diǎn)，其作用是把開發(fā)階段的工作劃更加明確化、使本來(lái)連續(xù)的工作在這點(diǎn)斷開，以便于檢查和評(píng)價(jià)階段成果圖：軟件開發(fā)中的基線3.4軟件配置管理概述版本與版本控制——軟件配置是一個(gè)動(dòng)態(tài)的概念，它一方面隨著軟件生存周期向前推進(jìn)，另一方面隨時(shí)會(huì)有新的變種出現(xiàn)V1.0V1.2V1.1V1.3V1.4V2.0V2.1V1.1.1V1.1.2圖：版本演變與變種3.4配置管理的基本概念版本與版本控制軟件的每一個(gè)版本都是源代碼、文檔及數(shù)據(jù)以及相關(guān)的系統(tǒng)環(huán)境的一個(gè)收集，且各個(gè)版本都可能由不同的變種組成。版本控制的目的是按照一定的規(guī)則保存配置項(xiàng)的所有版本，避免發(fā)生版本丟失或混淆等現(xiàn)象，并且可以快速準(zhǔn)確地查找到配置項(xiàng)的任何版本。3.4配置管理的基本概念版本控制規(guī)則處于“草稿”狀態(tài)的配置項(xiàng)的版本號(hào)格式為：0.YZYZ數(shù)字范圍為01-99處于“正式發(fā)布”狀態(tài)的配置項(xiàng)的版本號(hào)格式為：X.YX為主版本號(hào)，取值范圍為1-9。Y為次版本號(hào)，取值范圍為1-9處于“正在修改”狀態(tài)的配置項(xiàng)的版本號(hào)格式為：X.YZ配置項(xiàng)正在修改時(shí)，一般只增大Z值，X.Y值保持不變3.4配置管理的基本概念配置管理委員會(huì)配置管理委員會(huì)(SoftwareConfigurationControlBoard，SCCB)是實(shí)現(xiàn)有序、及時(shí)和正確處理軟件配置項(xiàng)的基本機(jī)制。主要負(fù)責(zé)評(píng)估變更批準(zhǔn)變更申請(qǐng)?jiān)谏嫫趦?nèi)規(guī)范變更申請(qǐng)流程對(duì)變更進(jìn)行反饋與項(xiàng)目管理層溝通

3.5軟件項(xiàng)目配置管理過程配置管理基本活動(dòng)配置管理計(jì)劃配置項(xiàng)標(biāo)志配置項(xiàng)控制狀態(tài)狀況報(bào)告配置項(xiàng)審核配置管理過程配置項(xiàng)標(biāo)識(shí)、跟蹤配置管理環(huán)境建立基線變更管理基線審核配置狀態(tài)統(tǒng)計(jì)配置管理計(jì)劃——配置管理過程圍繞配置管理的5項(xiàng)活動(dòng)進(jìn)行3.5軟件項(xiàng)目配置管理過程項(xiàng)目配置管理過程配置管理計(jì)劃就是確定軟件配置管理的解決方案，一個(gè)關(guān)鍵任務(wù)是確定要控制哪些文檔。配置項(xiàng)標(biāo)志、跟蹤一個(gè)項(xiàng)目通常會(huì)生成很多的過程文件，并經(jīng)歷不同的階段和版本3.5軟件項(xiàng)目配置管理過程項(xiàng)目配置管理過程配置管理環(huán)境建立

——建立配置管理庫(kù)，簡(jiǎn)稱配置庫(kù)。軟件配置管理庫(kù)是用來(lái)存儲(chǔ)所有基線配置項(xiàng)及相關(guān)文件的等內(nèi)容的系統(tǒng)，是在軟件產(chǎn)品的整個(gè)生存期中建立和維護(hù)軟件產(chǎn)品完整性的主要手段。開發(fā)庫(kù)受控庫(kù)產(chǎn)品庫(kù)3.5軟件項(xiàng)目配置管理過程項(xiàng)目配置管理過程配置管理環(huán)境建立

受控操作:從受控庫(kù)導(dǎo)出的文件自動(dòng)被鎖定直到文件重新被導(dǎo)入，一個(gè)版本號(hào)自動(dòng)與新版本文件相關(guān)聯(lián)。配置庫(kù)中文件不能更改，任何更改都被視為創(chuàng)建了一個(gè)新版本文件。3.5軟件項(xiàng)目配置管理過程項(xiàng)目配置管理過程基線變更管理——項(xiàng)目基線（配置項(xiàng)）可能由于種種原因會(huì)發(fā)生變更，如：客戶需求變化、進(jìn)度變更、成本變更、產(chǎn)品環(huán)境變化等。配置控制變更請(qǐng)求變更評(píng)估批準(zhǔn)/拒絕變更實(shí)現(xiàn)3.5軟件項(xiàng)目配置管理過程項(xiàng)目配置管理過程基線變更管理變更請(qǐng)求項(xiàng)目名稱變更申請(qǐng)人提交時(shí)間變更題目緊急程度變更的具體內(nèi)容變更影響分析變更確定處理結(jié)果簽字3.5軟件項(xiàng)目配置管理過程項(xiàng)目配置管理過程基線變更管理變更評(píng)估變更評(píng)估軟件變更分類技術(shù)影響分析接口影響分析進(jìn)度影響分析預(yù)算影響分析3.5軟件項(xiàng)目配置管理過程項(xiàng)目配置管理過程基線變更管理變更批準(zhǔn)或拒絕批準(zhǔn)/拒絕變更（若批準(zhǔn)）實(shí)施變更決策（若批準(zhǔn)）驗(yàn)證變更（若批準(zhǔn)）發(fā)布、安裝變更（若批準(zhǔn)）版本更新3.5軟件項(xiàng)目配置管理過程項(xiàng)目配置管理過程基線變更管理變更批準(zhǔn)或拒絕變更實(shí)現(xiàn)變更實(shí)現(xiàn)受控基線出庫(kù)實(shí)現(xiàn)的測(cè)試和驗(yàn)證實(shí)現(xiàn)被承認(rèn)受控基線入庫(kù)2.5軟件項(xiàng)目配置管理過程項(xiàng)目配置管理過程配置審核——配置審核作為變更控制的補(bǔ)充手段，目的是為了確保某一變更請(qǐng)求已被確切實(shí)現(xiàn)。配置審核主要包括兩方面的內(nèi)容：配置管理活動(dòng)審核基線審核3.5軟件項(xiàng)目配置管理過程項(xiàng)目配置管理過程

狀態(tài)報(bào)告——定期檢測(cè)軟件配置管理系統(tǒng)的運(yùn)行情況以及配置項(xiàng)本身的變更歷史記錄，并且將這些結(jié)果以報(bào)告的形式給出。3.6配置管理組織與實(shí)施配置管理組織

組織機(jī)構(gòu)責(zé)任具體職責(zé)項(xiàng)目經(jīng)理負(fù)責(zé)整個(gè)軟件項(xiàng)目的研發(fā)活動(dòng)，根據(jù)SCCB的建議，批準(zhǔn)配置管理的各項(xiàng)活動(dòng)并控制它們的進(jìn)程·制定和修改項(xiàng)目的組織結(jié)構(gòu)和配置管理策略·批準(zhǔn)、發(fā)布配置管理計(jì)劃·決定項(xiàng)目起始基線和開發(fā)里程碑·接收并審閱SCCB的報(bào)告軟件配置控制委員會(huì)（SCCB）管理軟件基線，承擔(dān)變更控制的所有責(zé)任·授權(quán)建立軟件基線和標(biāo)志配置/配置單元·代表項(xiàng)目經(jīng)理和受到基線影響的質(zhì)量保證組、配置管理組、工程組、系統(tǒng)測(cè)試組、合同管理組、文檔支持組等小組的利益·審查和審定對(duì)軟件基線的更改·審定由軟件基線數(shù)據(jù)庫(kù)中生產(chǎn)的產(chǎn)品和報(bào)告軟件配置小組（SCM小組）負(fù)責(zé)協(xié)調(diào)和實(shí)施項(xiàng)目·創(chuàng)建和管理項(xiàng)目的軟件基線庫(kù)·制定、維護(hù)和發(fā)布SCM計(jì)劃、標(biāo)準(zhǔn)和規(guī)程·標(biāo)志置于配置管理下的軟件工作產(chǎn)品集合·管理軟件基線的庫(kù)的使用·更新軟件基線·生成基于軟件基線的產(chǎn)品·記錄SCM活動(dòng)·生成和發(fā)布SCM報(bào)告開發(fā)人員負(fù)責(zé)開發(fā)任務(wù)·根據(jù)組織內(nèi)確定的軟件配置管理計(jì)劃和相關(guān)規(guī)定，按照軟件配置管理工具的使用模型來(lái)完成開發(fā)任務(wù)3.6配置管理組織與實(shí)施配置管理實(shí)施——主要包括的活動(dòng)確定初始基線——由SCCB確定研發(fā)活動(dòng)的初始基線；配置庫(kù)管理——配置人員根據(jù)軟件配置管理規(guī)劃設(shè)立配置庫(kù)和工作空間，為執(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)展情況，并適時(shí)地建立基線，批準(zhǔn)基線變更，保證開發(fā)和維護(hù)工作有序地進(jìn)行；產(chǎn)品開發(fā)——系統(tǒng)集成人員進(jìn)行產(chǎn)品集成，由SCCB批準(zhǔn)，進(jìn)行發(fā)布。3.6配置管理組織與實(shí)施配置管理工具——分為3個(gè)級(jí)別第一個(gè)級(jí)別

版本控制工具，是入門級(jí)的工具。例如，CVS、VisualSourceSafe。第二個(gè)級(jí)別項(xiàng)目級(jí)配置管理工具，適合管理中小型的項(xiàng)目，在版本管理的基礎(chǔ)上增加變更控制、狀態(tài)統(tǒng)計(jì)的功能。例如ClearCase