第8章 軟件文檔管理_免費下載.ppt

1、2020年7月29日星期三,1,軟件文檔與標(biāo)準(zhǔn),徐承志,第8章 軟件文檔管理,2,2020年7月29日星期三,8 軟件文檔管理 在軟件生命周期內(nèi)，由于項目開發(fā)過程的復(fù)雜性、多方人員參加以及時間跨度較長等因素的存在，軟件文檔作為記載“軟件歷史”的載體，記載了所有與軟件有關(guān)的需求、建議、方案、結(jié)論和過程等，是保證開發(fā)任務(wù)之間聯(lián)系的憑證和管理依據(jù)，也是保證軟件正常運行和維護(hù)支持的基礎(chǔ)支撐。 因此，軟件文檔的專業(yè)化、標(biāo)準(zhǔn)化和規(guī)范管理，是整個項目管理中不可忽視的重要組成。,1. 軟件文檔管理 文檔管理的目的是使文檔能夠發(fā)揮其應(yīng)該發(fā)揮的作用。因此，文檔管理工作應(yīng)該貫穿軟件生命周期的全過程。軟件文檔的管理過

2、程分為4個部分，如右圖所示。 隨著軟件工程化方法的不斷普及，軟件文檔管理已經(jīng)逐步取代數(shù)據(jù)管理，而成為軟件開發(fā)的中心。CASE工具中，對文檔的支持也已經(jīng)成為開發(fā)平臺的一個基本配置。 隨著多媒體技術(shù)的發(fā)展，文檔的內(nèi)容也從簡單的文本發(fā)展到集文字、圖形、圖像、表格、聲音、流程圖等各種復(fù)雜對象的集合。,3,2020年7月29日星期三, 文檔的形成 軟件項目的每個參與者，尤其是項目負(fù)責(zé)人，應(yīng)該明確文檔是軟件產(chǎn)品不可或缺的重要組成部分。軟件開發(fā)各個階段文檔按期保質(zhì)的完成，是該階段工作正式完成的有形標(biāo)志。文檔的形成過程必須嚴(yán)格按照規(guī)定進(jìn)行，把好編制、評審、版本管理等環(huán)節(jié)，以保證文檔質(zhì)量。文檔形成過程如圖所示。

3、,4,2020年7月29日星期三, 文檔的分類和標(biāo)識 在軟件開發(fā)過程中，會有各種不同類型的文檔，從各個不同崗位的人員手中產(chǎn)生。為了便于保存、查找、使用和修改，需要對文檔進(jìn)行結(jié)構(gòu)化、分層次的組織和管理。 通常，對文檔的標(biāo)識方法由軟件開發(fā)企業(yè)自己完成，使文檔的每一頁都有明確的標(biāo)識。例如，可以按以下4個層次對文檔加以分類和標(biāo)識： - 文檔所屬項目的標(biāo)識 - 文檔種類的標(biāo)識。如按軟件文檔的編制形式或按軟件功能進(jìn)行分類 - 同一文檔的不同版本號 - 文檔的性質(zhì)、保密級別和可供借閱的范圍等,5,2020年7月29日星期三, 軟件文檔的管理和控制 隨著項目進(jìn)程的深入，軟件文檔的數(shù)量、種類和使用的場合等也在不

4、斷的增加，因此，必須對文檔加以周密的管理和控制，以保持文檔與產(chǎn)品的一致性，保持各種文檔之間的一致性，保證文檔各個版本之間的有序性，保證文檔的安全性。這樣的管理和控制可以表現(xiàn)為以下幾個方面： - 項目組設(shè)置專職文檔管理員，集中保管文檔 - 所有保管文檔均應(yīng)有編制人、審核人、批準(zhǔn)人和保管人的簽字 - 保管的文檔應(yīng)確保安全。通常保存內(nèi)容完全一致的2套，其中一套可出借 - 保管文檔的出借應(yīng)按照規(guī)定的文檔涉眾范圍，辦理借閱手續(xù)，按時歸還 - 項目組成員自己的文檔自己保管，但應(yīng)按時提交，并確保內(nèi)容的一致性 - 為確保項目及文檔安全，項目組所有成員不得持有完整文檔 - 及時反映文檔版本更新，注銷并封存舊版本

5、 - 項目將結(jié)束時，文檔保管員應(yīng)及時收攏散存的文檔，檢查內(nèi)容，確保完整,6,2020年7月29日星期三, 文檔的修改管理 在項目開發(fā)過程的任何時刻，都會有項目組成員以種種理由對文檔進(jìn)行修改。文檔修改所帶來的影響可能很小，也可能會牽涉許多方面。因此，文檔修改必須謹(jǐn)慎，文檔修改活動必須嚴(yán)加管理，文檔修改過程必須嚴(yán)格遵守相關(guān)規(guī)程，使整個文檔修改活動都能有序受控的進(jìn)行。 具體的文檔修改活動大致可以分為以下5個步驟： - 建議。項目組任何成員都可以提出修改建議，并提交修改建議表，說明修改理由、內(nèi)容和涉及的文檔及部位 - 評議。文檔修改建議應(yīng)經(jīng)過評議方可實施。評議內(nèi)容包括建議的有效性，修改的必要性，確定修

6、改的范圍，研究修改的方法、步驟和實施計劃 - 審核。審核包括核實修改建議包含的內(nèi)容，核實修改活動將帶來的影響，審核修改活動計劃的可行性。審核工作通常由項目負(fù)責(zé)人承擔(dān) - 批準(zhǔn)。由開發(fā)單位的相關(guān)部門負(fù)責(zé)人批準(zhǔn)。批準(zhǔn)時，應(yīng)確認(rèn)修改活動的內(nèi)容、計劃、責(zé)任人和完成日期，以保證不影響整個項目的進(jìn)程 - 實施。由修改責(zé)任人按修改計劃承擔(dān)具體的修改任務(wù)，完成后交文檔管理員歸檔，并分發(fā)給有關(guān)持有者。,7,2020年7月29日星期三,2. 軟件文檔的管理方式 合理有效的管理已經(jīng)形成的軟件文檔，是加強(qiáng)軟件開發(fā)過程管理，提高軟件產(chǎn)品質(zhì)量，持續(xù)改進(jìn)開發(fā)組織過程能力的重要問題。 軟件文檔的管理，可以從技術(shù)角度和管理角度

7、提出和形成各自有效的管理方法。 從技術(shù)角度，文檔的管理維護(hù)有兩種方式： - 采用手工、靜態(tài)的管理方式。該方法在編檔、整理及修訂時，手工作業(yè)，勞動強(qiáng)度大，應(yīng)用時有較大局限 - 采用新方法、新工具。如CASE、軟件集成、動態(tài)管理、自動代碼生成、萬能查詢系統(tǒng)等。這類方法和工具雖然需要有一定的投入，但對項目開發(fā)帶來的持續(xù)效益巨大。 從管理角度看，文檔管理和系統(tǒng)管理的方式是密切相關(guān)的，管理方式的演變經(jīng)歷了三個階段： - 分散式管理。在網(wǎng)絡(luò)的每一結(jié)點都有獨立的管理系統(tǒng)，各結(jié)點間通過消息傳遞管理信息。其優(yōu)點是，執(zhí)行速度快，缺點是管理復(fù)雜，不易維護(hù)。這一時期產(chǎn)生的軟件文檔也會比較空泛 - 集中管理。優(yōu)點是管理

8、簡單，易于維護(hù)系統(tǒng)的一致性。缺點是效率較低，不適合現(xiàn)代網(wǎng)絡(luò)環(huán)境。這一時期產(chǎn)生的文檔結(jié)構(gòu)單一，形式較模糊 - 分布式管理。分布式管理介于分散和集中之間，是一種有序的分散、靈活的集中，可以提供服務(wù)的透明性和任務(wù)執(zhí)行的并發(fā)性。,8,2020年7月29日星期三,由于軟件文檔的對象復(fù)雜性，將面向?qū)ο蠹夹g(shù)和分布式系統(tǒng)管理思想結(jié)合，作用在對分布式符合文檔的對象管理上，產(chǎn)生了兩個新的重要概念： - 域。將系統(tǒng)中具有相似屬性的成員集合，以形成管理域(management domain)。每個域?qū)?yīng)一個對象分組，可以提供靈活的對象操作。 - 訪問規(guī)則。規(guī)定不同用戶訪問系統(tǒng)的權(quán)限和操作。訪問規(guī)則的實現(xiàn)一般需要對每個

9、規(guī)則對象進(jìn)行匹配，因此必須考慮訪問控制的效率問題。 分布式軟件工程除了要求軟件文檔管理必須適應(yīng)分布式系統(tǒng)的特點之外，還應(yīng)增加一些新功能，如： - 支持組件協(xié)作和方法學(xué) - 可配置的分布式軟件工程環(huán)境，支持域程序設(shè)計 - 在不同的開發(fā)階段使用不同形式的文檔 - 不同文檔工具生成的文檔能夠兼容 - 能夠在不同文檔之間導(dǎo)航查詢 - 各個文檔保證一致性、完整性，有完善的可配置管理機(jī)制,9,2020年7月29日星期三,目前，已經(jīng)有一些CASE系統(tǒng)提供了文檔支持和管理工具，典型的原型系統(tǒng)有以下兩個，但他們都不能在Internet上運行 - HyperCASE。由Amdahl Australian和LaTr

10、obe University聯(lián)合開發(fā)。由分布式文檔編輯、超文本瀏覽、文檔一致性維護(hù)等功能。 - CONIC。英國帝國學(xué)院研制。側(cè)重分布式系統(tǒng)描述，采用類似C+的分布式描述語言Darwin實現(xiàn)分布式軟件的組成、行為、通信和配置。 文檔管理系統(tǒng)在商業(yè)和企業(yè)實際應(yīng)用中已很成熟，最著名的LotusNotes為群組工作提供了優(yōu)越的文檔開發(fā)、管理、復(fù)制功能，能與WWW瀏覽器互聯(lián)，滿足分布式需求。,10,2020年7月29日星期三,3. 軟件文檔的維護(hù) 完善的文檔可以對軟件可維護(hù)性起決定性的作用。對于具有高度邏輯性和復(fù)雜性的軟件產(chǎn)品，如果沒有相關(guān)必要的文檔，其維護(hù)工作將無從談起。 而軟件文檔和任何其它產(chǎn)品一

11、樣，不可能在其編制完成后不需要進(jìn)行必要的修改和維護(hù)。這是由軟件及其文檔會不斷更新、發(fā)展的特性，及文檔必須與相應(yīng)的軟件保持高度一致的特性所決定的。 所以，在文檔編制過程中，就有必要考慮文檔日后維護(hù)的問題。這就要求做到以下幾點： - 在文檔規(guī)劃、編制的過程中，為維護(hù)留有必要的空間，以利于在軟件開發(fā)過程中補(bǔ)充新增內(nèi)容，或修改、完善文檔。 - 采用先進(jìn)的文檔維護(hù)技術(shù)。如使用一些較好的軟件文檔設(shè)計工具和項目開發(fā)工具。 - 可用附加文檔，即使用附加被維護(hù)文檔的維護(hù)文檔等手段，來反映相對較大的維護(hù)，減少對原文檔的修改量，以降低修改的難度和成本。,11,2020年7月29日星期三,4. 動態(tài)文檔管理 隨著軟件

12、規(guī)模的不斷擴(kuò)大，軟件開發(fā)方法的推陳出新，軟件文檔的規(guī)模和數(shù)量也在不斷增加，軟件文檔管理正從簡單的、靜態(tài)的管理向復(fù)雜的、動態(tài)的方向發(fā)展。這種新型文檔管理包含了各種對象的相關(guān)信息和結(jié)構(gòu)，是一致可動態(tài)訪問的文檔。 動態(tài)文檔是由各種文檔元素對象(文字、圖形、圖像、工作表等)以及一些控制信息組成，包括以下內(nèi)容： - 文檔對象信息：是具體的文檔對象內(nèi)容 - 文檔行為信息：包括文檔訪問控制，在工作流中的位置等信息 - 文檔附加信息：如作者、日期、狀態(tài)等，用于文檔一致性和版本維護(hù) - 鏈接：相當(dāng)于指向其它文檔的“指針” 動態(tài)文檔的概念使得軟件成為真正意義上的軟件：程序 + 文檔，程序就是文檔，文檔包含在程序中

13、。它要求軟件在規(guī)劃、設(shè)計時，就要考慮日后對文檔的維護(hù)支持。 動態(tài)文檔是保持文檔與程序一致、簡單易懂的聯(lián)機(jī)文檔系統(tǒng)，是提高文檔可用性、易用性、實時性、連貫性和有效性，解決維護(hù)問題的有效途徑。 動態(tài)文檔系統(tǒng)需要解決的問題包括軟件文檔的內(nèi)容劃分與獲取、文檔的存儲與維護(hù)、文檔的檢索、軟件文檔的生成打印等。,Javadoc自動將注釋變成幫助文檔。,12,2020年7月29日星期三,5. 項目管理軟件 項目管理技術(shù)的發(fā)展與計算機(jī)技術(shù)的發(fā)展密不可分，軟件文檔管理和軟件項目管理也有十分密切的關(guān)系。 隨著計算機(jī)性能的不斷提高，大量項目管理軟件涌向市場。這些項目管理軟件大都可以應(yīng)用于各種商業(yè)活動，提供便于操作的界面，幫助用戶制定任務(wù)和計劃進(jìn)度，進(jìn)行資源管理、成本預(yù)算、項目跟蹤等。 現(xiàn)在，市面上常見的項目管理軟件大致可以按照用戶對象分為兩個檔次： - 專供項目管理人士使用的高檔項