軟件文檔(document)也稱文件，通常指的是一些記錄的數(shù)據(jù) 和數(shù)據(jù)媒體，它具有固定不變的形式，可被人和計(jì)算機(jī)閱讀。它和 計(jì)算機(jī)程序共同構(gòu)成了能完成特定功能的計(jì)算機(jī)軟件(有人把源 程序也當(dāng)作文檔的一部分)。我們知道，硬件產(chǎn)品和產(chǎn)品資料在整 個(gè)生產(chǎn)過(guò)程中都是有形可見(jiàn)的，軟件生產(chǎn)則有很大不同，文檔本 身就是軟件產(chǎn)品。沒(méi)有文檔的軟件，不成其為軟件，更談不到軟件 產(chǎn)品。軟件文檔的編制(documentation)在軟件開(kāi)發(fā)工作中占有突 出的地位和相當(dāng)?shù)墓ぷ髁俊８咝?、高質(zhì)量地開(kāi)發(fā)、分發(fā)、管理和維 護(hù)文檔對(duì)于轉(zhuǎn)讓、變更、修正、擴(kuò)充和使用文檔，對(duì)于充分發(fā)揮軟 件產(chǎn)品的效益有著重要意義。

    然而，在實(shí)際工作中，文檔在編制和使用中存在著許多問(wèn) 題，有待于解決。軟件開(kāi)發(fā)人員中較普遍地存在著對(duì)編制文檔不感 興趣的現(xiàn)象。從用戶方面看，他們又常常抱怨：文檔售價(jià)太高、文 檔不夠完整、文檔編寫得不好、文檔已經(jīng)陳舊或是文檔太多，難于 使用等等。究竟應(yīng)該怎樣要求它，文檔應(yīng)該寫哪些，說(shuō)明什么問(wèn) 題，起什么作用?這里將給出簡(jiǎn)要的介紹。

圖 文檔橋梁作用

    文檔在軟件開(kāi)發(fā)人員、軟件管理人員、維護(hù)人員、用戶以及計(jì) 算機(jī)之間的多種橋梁作用可從圖9．2中看出。軟件開(kāi)發(fā)人員在各 個(gè)階段中以文檔作為前階段工作成果的體現(xiàn)和后階段工作的依 據(jù)，這個(gè)作用是顯而易見(jiàn)的。軟件開(kāi)發(fā)過(guò)程中軟件開(kāi)發(fā)人員需制定 一些工作計(jì)劃或工作報(bào)告，這些計(jì)劃和報(bào)告都要提供給管理人員， 并得到必要的支持。管理人員則可通過(guò)這些文檔了解軟件開(kāi)發(fā)項(xiàng) 目安排、進(jìn)度、資源使用和成果等。軟件開(kāi)發(fā)人員需為用戶了解軟 件的使用、操作和維護(hù)提供詳細(xì)的資料，我們稱此為用戶文檔。以 上三種文檔構(gòu)成了軟件文檔的主要部分。我們把這三種文檔所包 括的內(nèi)容列在圖6中。其中列舉了十三個(gè)文檔，這里對(duì)它們作 一些簡(jiǎn)要說(shuō)明：

• 可行性研究報(bào)告：說(shuō)明該軟件開(kāi)發(fā)項(xiàng)目的實(shí)現(xiàn)在技術(shù)上、經(jīng) 濟(jì)上和社會(huì)因素上的可行性，評(píng)述為了合理地達(dá)到開(kāi)發(fā)目標(biāo)可供 選擇的各種可能實(shí)施的方案，說(shuō)明并論證所選定實(shí)施方案的理 由。
• 項(xiàng)目開(kāi)發(fā)計(jì)劃：為軟件項(xiàng)目實(shí)施方案制定出具體計(jì)劃，應(yīng) 該包括各部分工作的負(fù)責(zé)人員、開(kāi)發(fā)的進(jìn)度、開(kāi)發(fā)經(jīng)費(fèi)的預(yù)算、所 需的硬件及軟件資源等。項(xiàng)目開(kāi)發(fā)計(jì)劃應(yīng)提供給管理部門，并作 為開(kāi)發(fā)階段評(píng)審的參考。
• 軟件需求說(shuō)明書：也稱軟件規(guī)格說(shuō)明書，其中對(duì)所開(kāi)發(fā)軟 件的功能、性能、用戶界面及運(yùn)行環(huán)境等作出詳細(xì)的說(shuō)明。它是用 戶與開(kāi)發(fā)人員雙方對(duì)軟件需求取得共同理解基礎(chǔ)上達(dá)成的協(xié)議， 也是實(shí)施開(kāi)發(fā)工作的基礎(chǔ)。
• 數(shù)據(jù)要求說(shuō)明書：該說(shuō)明書應(yīng)給出數(shù)據(jù)邏輯描述和數(shù)據(jù)采 集的各項(xiàng)要求，為生成和維護(hù) 系統(tǒng)數(shù)據(jù)文卷作好準(zhǔn)備。
• 概要設(shè)計(jì)說(shuō)明書：該說(shuō) 明書是概要設(shè)計(jì)階段的工作 成果，它應(yīng)說(shuō)明功能分配、模 塊劃分、程序的總體結(jié)構(gòu)、輸 入輸出以及接口設(shè)計(jì)、運(yùn)行設(shè) 計(jì)、數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)和出錯(cuò)處理 設(shè)計(jì)等，為詳細(xì)設(shè)計(jì)奠定基 礎(chǔ)。
• 詳細(xì)設(shè)計(jì)說(shuō)明書：著重 描述每一模塊是怎樣實(shí)現(xiàn)的， 包括實(shí)現(xiàn)算法、邏輯流程等。 ·用戶手冊(cè)：本手冊(cè)詳細(xì) 描述軟件的功能、性能和用戶 界面，使用戶了解如何使用該軟件。
  
  

  文檔		用戶文檔		用戶手冊(cè)
  				操作手冊(cè)
  				維護(hù)修改建議
  				軟件需求（規(guī)格）說(shuō)明書
  		開(kāi)發(fā)文檔		軟件需求（規(guī)格）說(shuō)明書
  				數(shù)據(jù)要求說(shuō)明書
  				概要設(shè)計(jì)說(shuō)明書
  				詳細(xì)設(shè)計(jì)說(shuō)明書
  				可行性研究報(bào)告
  				項(xiàng)目開(kāi)發(fā)計(jì)劃
  		管理文檔		項(xiàng)目開(kāi)發(fā)計(jì)劃
  				測(cè)試計(jì)劃
  				測(cè)試報(bào)告
  				開(kāi)發(fā)進(jìn)度月報(bào)
  				開(kāi)發(fā)總結(jié)報(bào)告

  
  圖 三種文檔
  
  
• 操作手冊(cè)：本手冊(cè)為操作人員提供該軟件各種運(yùn)行情況的 有關(guān)知識(shí)，特別是操作方法的具體細(xì)節(jié)。
• 測(cè)試計(jì)劃：為做好組裝測(cè)試和確認(rèn)測(cè)試，需為如何組織測(cè)試 制定實(shí)施計(jì)劃。計(jì)劃應(yīng)包括測(cè)試的內(nèi)容、進(jìn)度、條件、人員、測(cè)試用 例的選取原則、測(cè)試結(jié)果允許的偏差范圍等。
• 測(cè)試分析報(bào)告：測(cè)試工作完成以后，應(yīng)提交測(cè)試計(jì)劃執(zhí)行 情況的說(shuō)明。對(duì)測(cè)試結(jié)果加以分析，并提出測(cè)試的結(jié)論意見(jiàn)。
• 開(kāi)發(fā)進(jìn)度月報(bào)：該月報(bào)系軟件人員按月向管理部門提交的 項(xiàng)目進(jìn)展情況報(bào)告。報(bào)告應(yīng)包括進(jìn)度計(jì)劃與實(shí)際執(zhí)行情況的比較、 階段成果、遇到的問(wèn)題和解決的辦法以及下個(gè)月的打算等。
• 項(xiàng)目開(kāi)發(fā)總結(jié)報(bào)告：軟件項(xiàng)目開(kāi)發(fā)完成以后，應(yīng)與項(xiàng)目實(shí) 施計(jì)劃對(duì)照，總結(jié)實(shí)際執(zhí)行的情況，如進(jìn)度、成果、資源利用、成本 和投入的人力。此外還需對(duì)開(kāi)發(fā)工作作出評(píng)價(jià)，總結(jié)出經(jīng)驗(yàn)和教 訓(xùn)。
• 維護(hù)修改建議，軟件產(chǎn)品投入運(yùn)行以后，發(fā)現(xiàn)了需對(duì)其進(jìn) 行修正、更改等問(wèn)題，應(yīng)將存在的問(wèn)題、修改的考慮以及修改的影 響估計(jì)作詳細(xì)的描述，寫成維護(hù)修改建議，提交審批。 以上這些文檔是在軟件生存期中，隨著各階段工作的開(kāi)展適 時(shí)編制。其中有的僅反映一個(gè)階段的工作，有的則需跨越多個(gè)階 段。表5給出了各個(gè)文檔應(yīng)在軟件生存期中哪個(gè)階段編寫。這 些文檔最終要向軟件管理部門，或是向用戶回答以下的問(wèn)題：
  表9.2 軟件生存期各階段編制的文檔

  階段 文檔	可行性藥酒與計(jì)劃	需求分析	設(shè)計(jì)	代碼編寫	測(cè)試	運(yùn)行與維護(hù)
  可行性研究報(bào)告
  項(xiàng)目開(kāi)發(fā)計(jì)劃
  軟件需求說(shuō)明
  數(shù)據(jù)要求說(shuō)明
  概要設(shè)計(jì)說(shuō)明
  星系設(shè)計(jì)說(shuō)明
  測(cè)試計(jì)劃
  用戶手冊(cè)
  操作手冊(cè)
  測(cè)試分析報(bào)告
  開(kāi)發(fā)進(jìn)度月報(bào)
  項(xiàng)目開(kāi)發(fā)總結(jié)
  維護(hù)修改建議

  
  
  
• 哪些需求要被滿足，即回答“做什么?”
• 所開(kāi)發(fā)的軟件在什么環(huán)境中實(shí)現(xiàn)以及所需信息從哪里來(lái)， 即回答“從何處?”
• 某些開(kāi)發(fā)工作的時(shí)間如何安排，即回答“何時(shí)干?”
• 某些開(kāi)發(fā)(或維護(hù))工作打算由“誰(shuí)來(lái)干?”
• 某些需求是怎么實(shí)現(xiàn)的?
• 為什么要進(jìn)行那些軟件開(kāi)發(fā)或維護(hù)修改工作?

    上述十三個(gè)文檔都在一定程度上回答了這六個(gè)方面的問(wèn)題。這可從表中看到。

表 文檔所回答的問(wèn)題

    至此，我們對(duì)文檔的作用有了進(jìn)一步的理解。每一個(gè)文檔的任 務(wù)也是明確的，任何一個(gè)文檔都此是多余的。