軟件文檔的作用和分類

軟件文檔的作用和分類軟件文檔(document)也稱文件，通常指的是一些記錄的數(shù)據(jù)和數(shù)據(jù)媒體，它具有固定不變的形式，可被人和計算機閱讀。它和計算機程序共同構(gòu)成了能完成特定功能的計算機軟件(有人把源程序也當(dāng)作文檔的一部分)。我們知道，硬件產(chǎn)品和產(chǎn)品資料在整個生產(chǎn)過程中都是有形可見的，軟件生產(chǎn)則有很大不同，文檔本身就是軟件產(chǎn)品。沒有文檔的軟件，不成其為軟件，更談不到軟件產(chǎn)品。軟件文檔的編制(documentation)在軟件開發(fā)工作中占有突出的地位和相當(dāng)?shù)墓ぷ髁俊８咝?、高質(zhì)量地開發(fā)、分發(fā)、管理和維護文檔對于轉(zhuǎn)讓、變更、修正、擴充和使用文檔，對于充分發(fā)揮軟件產(chǎn)品的效益有著重要意義。然而，在實際工作中，文檔在編制和使用中存在著許多問題，有待于解決。軟件開發(fā)人員中較普遍地存在著對編制文檔不感興趣的現(xiàn)象。從用戶方面看，他們又常常抱怨：文檔售價太高、文檔不夠完整、文檔編寫得不好、文檔已經(jīng)陳舊或是文檔太多，難于使用等等。究竟應(yīng)該怎樣要求它，文檔應(yīng)該寫哪些，說明什么問題，起什么作用?這里將給出簡要的介紹。圖文檔橋梁作用文檔在軟件開發(fā)人員、軟件管理人員、維護人員、用戶以及計算機之間的多種橋梁作用可從圖中看出。軟件開發(fā)人員在各個階段中以文檔作為前階段工作成果的體現(xiàn)和后階段工作的依據(jù)，這個作用是顯而易見的。軟件開發(fā)過程中軟件開發(fā)人員需制定一些工作計劃或工作報告，這些計劃和報告都要提供給管理人員，并得到必要的支持。管理人員則可通過這些文檔了解軟件開發(fā)項目安排、進度、資源使用和成果等。軟件開發(fā)人員需為用戶了解軟件的使用、操作和維護提供詳細的資料，我們稱此為用戶文檔。以上三種文檔構(gòu)成了軟件文檔的主要部分。我們把這三種文檔所包括的內(nèi)容列在圖6中。其中列舉了十三個文檔，這里對它們作一些簡要說明：?可行性研究報告：說明該軟件開發(fā)項目的實現(xiàn)在技術(shù)上、經(jīng)濟上和社會因素上的可行性，評述為了合理地達到開發(fā)目標可供選擇的各種可能實施的方案，說明并論證所選定實施方案的理由。?項目開發(fā)計劃：為軟件項目實施方案制定出具體計劃，應(yīng)該包括各部分工作的負責(zé)人員、開發(fā)的進度、開發(fā)經(jīng)費的預(yù)算、所需的硬件及軟件資源等。項目開發(fā)計劃應(yīng)提供給管理部門，并作為開發(fā)階段評審的參考。?軟件需求說明書：也稱軟件規(guī)格說明書，其中對所開發(fā)軟件的功能、性能、用戶界面及運行環(huán)境等作出詳細的說明。它是用戶與開發(fā)人員雙方對軟件需求取得共同理解基礎(chǔ)上達成的協(xié)議，也是實施開發(fā)工作的基礎(chǔ)。?數(shù)據(jù)要求說明書：該說明書應(yīng)給出數(shù)據(jù)邏輯描述和數(shù)據(jù)采集的各項要求，為生成和維護系統(tǒng)數(shù)據(jù)文卷作好準備。?概要設(shè)計說明書：該說明書是概要設(shè)計階段的工作成果，它應(yīng)說明功能分配、模塊劃

分、程序的總體結(jié)構(gòu)、輸入輸出以及接口設(shè)計、運行設(shè)計、數(shù)據(jù)結(jié)構(gòu)設(shè)計和出錯處理設(shè)計等，為詳細設(shè)計奠定基礎(chǔ)。?詳細設(shè)計說明書：著重描述每一模塊是怎樣實現(xiàn)的，包括實現(xiàn)算法、邏輯流程等。?用戶手冊：本手冊詳細描述軟件的功能、性能和用戶界面，使用戶了解如何使用該軟件。用戶文檔管理文檔用戶手冊用戶文檔管理文檔操作手冊維護修改建議軟件需求（規(guī)格）說明書軟件需求（規(guī)格）說明書數(shù)據(jù)要求說明書櫥要設(shè)計說明書樣細設(shè)計說明書可行性研究報告頊目開發(fā)計劃甌目開發(fā)計劃測試計刻測試報告開發(fā)進度月報開發(fā)總結(jié)報告圖三種文檔?操作手冊：本手冊為操作人員提供該軟件各種運行情況的有關(guān)知識，特別是操作方法的具體細節(jié)。?測試計劃：為做好組裝測試和確認測試，需為如何組織測試制定實施計劃。計劃應(yīng)包括測試的內(nèi)容、進度、條件、人員、測試用例的選取原則、測試結(jié)果允許的偏差范圍等。?測試分析報告：測試工作完成以后，應(yīng)提交測試計劃執(zhí)行情況的說明。對測試結(jié)果加以分析，并提出測試的結(jié)論意見。?開發(fā)進度月報：該月報系軟件人員按月向管理部門提交的項目進展情況報告。報告應(yīng)包括進度計劃與實際執(zhí)行情況的比較、階段成果、遇到的問題和解決的辦法以及下個月的打算等。?項目開發(fā)總結(jié)報告：軟件項目開發(fā)完成以后，應(yīng)與項目實施計劃對照，總結(jié)實際執(zhí)行的情況，如進度、成果、資源利用、成本和投入的人力。此外還需對開發(fā)工作作出評價，總結(jié)出經(jīng)驗和教訓(xùn)。

軟件需求說明數(shù)據(jù)要求說明概要設(shè)計說明■星系設(shè)計說明■測試計刻用戶手冊操作手冊測試分析報告開發(fā)進度月報項目開發(fā)總結(jié)■維護修改建議?哪些需求要被滿足，即回答”做什么?”?所開發(fā)的軟件在什么環(huán)境中實現(xiàn)以及所需信息從哪里來，即回答'從何處?”?某些開發(fā)工作的時間如何安排，即回答”何時干?”?某些開發(fā)（或維護）工作打算由”誰來干?”?某些需求是怎么實現(xiàn)的？?為什么要進行那些軟件開發(fā)或維護修改工作?上述十三個文檔都在一定程度上回答了這六個方面的問題。這可從表中看到。表文檔所回答的問題所提問題文檔什么何處何時誰如何為何可行性研究報告寸寸項目開發(fā)計劃寸~T\軟件需求說明V數(shù)據(jù)要求說明寸