軟件項(xiàng)目中涉及的文檔分類和作用

1、軟件項(xiàng)目中涉及的文檔分類和作用軟件項(xiàng)目中涉及的文檔分類和作用軟件項(xiàng)目中涉及的文檔分類和作用V:1.0精細(xì)整理，僅供參考 軟件項(xiàng)目中涉及的文檔分類和作用日期：20 xx年X月軟件項(xiàng)目中涉及的文檔分類和作用軟件文檔也稱文件，通常指的是一些記錄的數(shù)據(jù)和數(shù)據(jù)媒體，它具有固定不變的形式，可被人和計(jì)算機(jī)閱讀。它和計(jì)算機(jī)程序共同構(gòu)成了能完成特定功能的計(jì)算機(jī)軟件(有人把源程序也當(dāng)作文檔的一部分)。我們知道，硬件產(chǎn)品和產(chǎn)品資料在整個(gè)生產(chǎn)過程中都是有形可見的，軟件生產(chǎn)則有很大不同，文檔本身就是軟件產(chǎn)品。沒有文檔的軟件，不成其為軟件，更談不到軟件產(chǎn)品。軟件文檔的編制在軟件開發(fā)工作中占有突出的地位和相當(dāng)?shù)墓ぷ髁?。高?/p>

2、率、高質(zhì)量地開發(fā)、分發(fā)、管理和維護(hù)文檔對于轉(zhuǎn)讓、變更、修正、擴(kuò)充和使用文檔，對于充分發(fā)揮軟件產(chǎn)品的效益有著重要意義。 然而，在實(shí)際工作中，文檔在編制和使用中存在著許多問題，有待于解決。軟件開發(fā)人員中較普遍地存在著對編制文檔不感興趣的現(xiàn)象。從用戶方面看，他們又常常抱怨：文檔售價(jià)太高、文檔不夠完整、文檔編寫得不好、文檔已經(jīng)陳舊或是文檔太多，難于使用等等。究竟應(yīng)該怎樣要求它，文檔應(yīng)該寫哪些，說明什么問題，起什么作用這里將給出簡要的介紹。圖1： 文檔的橋梁作用 文檔在軟件開發(fā)人員、軟件管理人員、維護(hù)人員、用戶以及計(jì)算機(jī)之間的多種橋梁作用可從圖1中看出。軟件開發(fā)人員在各個(gè)階段中以文檔作為前階段工作成果的

3、體現(xiàn)和后階段工作的依據(jù)，這個(gè)作用是顯而易見的。軟件開發(fā)過程中軟件開發(fā)人員需制定一些工作計(jì)劃或工作報(bào)告，這些計(jì)劃和報(bào)告都要提供給管理人員，并得到必要的支持。管理人員則可通過這些文檔了解軟件開發(fā)項(xiàng)目安排、進(jìn)度、資源使用和成果等。軟件開發(fā)人員需為用戶了解軟件的使用、操作和維護(hù)提供詳細(xì)的資料，我們稱此為用戶文檔。以上三種文檔構(gòu)成了軟件文檔的主要部分。我們把這三種文檔所包括的內(nèi)容列在圖2中。其中列舉了十三個(gè)文檔，這里對它們作一些簡要說明：文檔用戶文檔用戶手冊操作手冊維護(hù)修改建議軟件需求（規(guī)格）說明書開發(fā)文檔軟件需求（規(guī)格）說明書數(shù)據(jù)要求說明書概要設(shè)計(jì)說明書詳細(xì)設(shè)計(jì)說明書可行性研究報(bào)告項(xiàng)目開發(fā)計(jì)劃管理文檔

4、項(xiàng)目開發(fā)計(jì)劃測試計(jì)劃測試報(bào)告開發(fā)進(jìn)度月報(bào)開發(fā)總結(jié)報(bào)告圖2： 三種文檔可行性研究報(bào)告：說明該軟件開發(fā)項(xiàng)目的實(shí)現(xiàn)在技術(shù)上、經(jīng)濟(jì)上和社會因素上的可行性，評述為了合理地達(dá)到開發(fā)目標(biāo)可供選擇的各種可能實(shí)施的方案，說明并論證所選定實(shí)施方案的理由。 項(xiàng)目開發(fā)計(jì)劃：為軟件項(xiàng)目實(shí)施方案制定出具體計(jì)劃，應(yīng)該包括各部分工作的負(fù)責(zé)人員、開發(fā)的進(jìn)度、開發(fā)經(jīng)費(fèi)的預(yù)算、所需的硬件及軟件資源等。項(xiàng)目開發(fā)計(jì)劃應(yīng)提供給管理部門，并作為開發(fā)階段評審的參考。 軟件需求說明書：也稱軟件規(guī)格說明書，其中對所開發(fā)軟件的功能、性能、用戶界面及運(yùn)行環(huán)境等作出詳細(xì)的說明。它是用戶與開發(fā)人員雙方對軟件需求取得共同理解基礎(chǔ)上達(dá)成的協(xié)議，也是實(shí)施開發(fā)

5、工作的基礎(chǔ)。 數(shù)據(jù)要求說明書：該說明書應(yīng)給出數(shù)據(jù)邏輯描述和數(shù)據(jù)采集的各項(xiàng)要求，為生成和維護(hù) 系統(tǒng)數(shù)據(jù)文卷作好準(zhǔn)備。 概要設(shè)計(jì)說明書：該說明書是概要設(shè)計(jì)階段的工作成果，它應(yīng)說明功能分配、模塊劃分、程序的總體結(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ì)說明書：著重描述每一模塊是怎樣實(shí)現(xiàn)的，包括實(shí)現(xiàn)算法、邏輯流程等。 用戶手冊：本手冊詳細(xì)描述軟件的功能、性能和用戶界面，使用戶了解如何使用該軟件。操作手冊：本手冊為操作人員提供該軟件各種運(yùn)行情況的有關(guān)知識，特別是操作方法的具體細(xì)節(jié)。 測試計(jì)劃：為做好組裝測試和確認(rèn)測試，需為如何組織測試制定實(shí)施計(jì)劃。

6、計(jì)劃應(yīng)包括測試的內(nèi)容、進(jìn)度、條件、人員、測試用例的選取原則、測試結(jié)果允許的偏差范圍等。 測試分析報(bào)告：測試工作完成以后，應(yīng)提交測試計(jì)劃執(zhí)行情況的說明。對測試結(jié)果加以分析，并提出測試的結(jié)論意見。 開發(fā)進(jìn)度月報(bào)：該月報(bào)系軟件人員按月向管理部門提交的項(xiàng)目進(jìn)展情況報(bào)告。報(bào)告應(yīng)包括進(jìn)度計(jì)劃與實(shí)際執(zhí)行情況的比較、階段成果、遇到的問題和解決的辦法以及下個(gè)月的打算等。 項(xiàng)目開發(fā)總結(jié)報(bào)告：軟件項(xiàng)目開發(fā)完成以后，應(yīng)與項(xiàng)目實(shí)施計(jì)劃對照，總結(jié)實(shí)際執(zhí)行的情況，如進(jìn)度、成果、資源利用、成本和投入的人力。此外還需對開發(fā)工作作出評價(jià)，總結(jié)出經(jīng)驗(yàn)和教訓(xùn)。 維護(hù)修改建議：軟件產(chǎn)品投入運(yùn)行以后，發(fā)現(xiàn)了需對其進(jìn)行修正、更改等問題，應(yīng)

7、將存在的問題、修改的考慮以及修改的影響估計(jì)作詳細(xì)的描述，寫成維護(hù)修改建議，提交審批。以上這些文檔是在軟件生存期中，隨著各階段工作的開展適時(shí)編制。其中有的僅反映一個(gè)階段的工作，有的則需跨越多個(gè)階段。表1給出了各個(gè)文檔應(yīng)在軟件生存期中哪個(gè)階段編寫。這些文檔最終要向軟件管理部門，或是向用戶回答以下的問題：階段文檔可行性要求與計(jì)劃需求分析設(shè)計(jì)代碼編寫測試運(yùn)行與維護(hù)可行性研究報(bào)告項(xiàng)目開發(fā)計(jì)劃軟件需求說明數(shù)據(jù)要求說明概要設(shè)計(jì)說明星系設(shè)計(jì)說明測試計(jì)劃用戶手冊操作手冊測試分析報(bào)告開發(fā)進(jìn)度月報(bào)項(xiàng)目開發(fā)總結(jié)維護(hù)修改建議表1： 軟件生存期各階段編制的文檔哪些需求要被滿足，即回答“做什么” 所開發(fā)的軟件在什么環(huán)境中實(shí)現(xiàn)以及所需信息從哪里來， 即回答“從何處” 某些開發(fā)工作的時(shí)間如何安排，即回答“何時(shí)干” 某些開發(fā)(或維護(hù))工作打算由“誰來干” 某些需求是怎么實(shí)現(xiàn)的 為什么要進(jìn)行那些軟件開發(fā)或維護(hù)修改工作 上述十三個(gè)文檔都在一定程度上回答了這六個(gè)方面的問題。這可從表2中看到。所提問題文檔什么何處何時(shí)誰如何為何可行性研究報(bào)告項(xiàng)目開發(fā)計(jì)劃軟