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

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

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

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

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

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

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

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

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

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

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

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

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