軟件開(kāi)發(fā)文檔說(shuō)明(完整流程)

1、在軟件行業(yè)有一句話：一個(gè)軟件能否順利的完成并且功能是否完善，重要是看這個(gè)軟件有多少文檔，軟件開(kāi)發(fā)文檔是一個(gè)軟件的支柱，如果你的開(kāi)發(fā)文檔漏洞百出，那么你所開(kāi)發(fā)出來(lái)的軟件也不可能會(huì)好；開(kāi)發(fā)文檔的好壞可以直接影響到所開(kāi)發(fā)出來(lái)軟件的成功與否。  一、軟件開(kāi)發(fā)設(shè)計(jì)文檔：軟件開(kāi)發(fā)文檔包括軟件需求說(shuō)明書(shū)、數(shù)據(jù)要求說(shuō)有書(shū)、概要設(shè)計(jì)說(shuō)明書(shū)、詳細(xì)設(shè)計(jì)說(shuō)明書(shū)。 1、軟件需求說(shuō)明書(shū)：也稱為軟件規(guī)格說(shuō)明。 該說(shuō)明書(shū)對(duì)所開(kāi)發(fā)軟件的功能、性能、用戶 界面及運(yùn)行環(huán)境等做出詳細(xì)的說(shuō)明。它是用戶與開(kāi)發(fā)人員雙方對(duì)軟件需求取得共同理 解基礎(chǔ)上達(dá)成的協(xié)議，也是實(shí)施開(kāi)發(fā)工作的基礎(chǔ)。軟件需求說(shuō)明書(shū)的編制目的的

2、就是 為了使用戶和軟件開(kāi)發(fā)者雙方對(duì)該軟件的初始規(guī)定有一個(gè)共同的理解、并使之面成為 整個(gè)開(kāi)發(fā)工作的基礎(chǔ)。其格式要求如下：  1 引言 11 編寫(xiě)目的。 12 背景 13 定義  2 任務(wù)概述 21 目標(biāo) 22 用戶的特點(diǎn) 23 假定和約束  3 需求規(guī)定 31 對(duì)功能的規(guī)定 32 對(duì)性能的規(guī)定 321 精度 3

3、22 時(shí)間特性的需求 323 靈活性 33 輸入輸出要求 34 數(shù)據(jù)管理能力要求 35 故障處理要求 36 其他專門(mén)要求  4 運(yùn)行環(huán)境規(guī)定 41 設(shè)備 42 支持軟件 43 接口 44 控制  2、概要設(shè)計(jì)說(shuō)明書(shū)：又稱系統(tǒng)設(shè)計(jì)說(shuō)明書(shū)，這里所說(shuō)的系統(tǒng)是指程序系統(tǒng)。編制的目的是說(shuō)明對(duì)程序系統(tǒng)的設(shè)計(jì)考慮，包括程序系統(tǒng)的基本處理。流程、程序系統(tǒng)的組織 結(jié)

4、構(gòu)、模塊劃分、功能分配、接口設(shè)計(jì)。運(yùn)河行設(shè)計(jì)、數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)和出錯(cuò)處理設(shè)計(jì)等，為程序的詳細(xì)設(shè)計(jì)提供基礎(chǔ)。其格式要求如下：  1 引言 11 編寫(xiě)目的 12 背景 13 定義 14 參考資料  2 總體設(shè)計(jì) 21 需求規(guī)定 22 運(yùn)行環(huán)境 23 基本設(shè)計(jì)概念和處理流程 24 結(jié)構(gòu) 25 功能需求與程序的關(guān)系 26 人工處理過(guò)程 27

5、 尚未解決的問(wèn)題  3 接口設(shè)計(jì) 31 用戶接口 32 外部接口 3.。3 內(nèi)部接口  4 運(yùn)行設(shè)計(jì) 41 運(yùn)行模塊的組合 42 運(yùn)行控制 43 運(yùn)行時(shí)間  5 系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì) 51 邏輯結(jié)構(gòu)設(shè)計(jì)要點(diǎn) 52 物理結(jié)構(gòu)設(shè)計(jì)要求 53 數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系  6 系統(tǒng)出錯(cuò)處理設(shè)計(jì) 

6、61 出錯(cuò)信息 62 補(bǔ)救措施 63 系統(tǒng)維護(hù)設(shè)計(jì)。  3.詳細(xì)設(shè)計(jì)文檔：主要是把我們每個(gè)小模塊，小功能的業(yè)務(wù)邏輯處理用文字的方式表達(dá)出來(lái)，讓程序員在編碼的時(shí)候有一個(gè)依據(jù)和參照；同時(shí)，在進(jìn)行詳細(xì)文檔設(shè)計(jì)的時(shí)候，有的軟件公司也會(huì)根據(jù)不同的項(xiàng)目作出相應(yīng)的軟件開(kāi)發(fā)代碼規(guī)范性文檔，以保障我們所做工作的統(tǒng)一性。如果一個(gè)軟件系比較簡(jiǎn)單，層次很少，本文件可以不單獨(dú)編寫(xiě)，有關(guān)內(nèi)容合并入概要設(shè)計(jì)說(shuō)明書(shū)。 其格式要求如下： 1 引言 11 編寫(xiě)目的 12 背景 13 定義&#

7、160;14 參考資料  2 程序設(shè)計(jì)系統(tǒng)的結(jié)構(gòu)  3 程序 1設(shè)計(jì)說(shuō)明 31 程序描述 32 功能 33 性能 34 輸入項(xiàng) 35 輸出項(xiàng) 36 算法 37 流程邏輯 38 接口 39 存儲(chǔ)分配 310 注釋設(shè)計(jì) 311 限制條件 312 測(cè)試計(jì)劃 313 

8、尚未解決的問(wèn)題  4 程序 2設(shè)計(jì)說(shuō)明 .    二、軟件開(kāi)發(fā)管理文檔：可行性研究報(bào)告、項(xiàng)目開(kāi)發(fā)計(jì)劃、開(kāi)發(fā)進(jìn)度月報(bào)、項(xiàng)目開(kāi)發(fā)總結(jié)、模塊開(kāi)發(fā)卷宗。 1.可行性研究報(bào)告：編寫(xiě)目的是，說(shuō)明該軟件開(kāi)發(fā)項(xiàng)目的實(shí)現(xiàn)在技術(shù)、經(jīng)濟(jì)和社會(huì)條件方面的可行性：評(píng)述為了合理達(dá)到開(kāi)發(fā)目標(biāo)而可能選擇的各種方案；說(shuō)明并論證所選定的方案。 其格式要求如下：  1 引言 11 編寫(xiě)目的 12 背景 13 定義 14 參考資料

9、60; 2 可行性研究的前提 21 要求 22 目標(biāo) 23 條件、假定和限制 24 進(jìn)行可行性研究的方法 25 評(píng)價(jià)尺度3 對(duì)現(xiàn)有系統(tǒng)的分析 31 處理流程和數(shù)據(jù)流程 32 工作負(fù)荷 33 費(fèi)用開(kāi)支 34 人員 35 設(shè)備36 局限性  4 所建議的系統(tǒng) 41 對(duì)所建議系統(tǒng)的說(shuō)明 42 處

10、理流程和數(shù)據(jù)流程 43 改進(jìn)之處 44 影響 441 結(jié)設(shè)備的影響 442 對(duì)軟件的影響 443 對(duì)用戶單位機(jī)構(gòu)的影響 444 對(duì)系統(tǒng)運(yùn)行過(guò)程的影響 445 對(duì)開(kāi)發(fā)的影響446 對(duì)地點(diǎn)和設(shè)備的影響 447 對(duì)經(jīng)費(fèi)開(kāi)支的影響  45 局限性  46 技術(shù)條件方面的可行性  5 可選擇的其他系統(tǒng)的可行性 51 可選擇的系統(tǒng)方案1 5

11、2 可選擇的系統(tǒng)方案2 6 投資及效益分析 61 支出 611 基本建設(shè)投資 612 其他一次性支出 613 非一次性支出 62 收益 621 一次性收益 622 非一次性收益 623 不可定量的收益 63 收益投資比 64 投資回收周期 65 敏感性分析  7 社會(huì)因素方面的可行性 71 法律方面

12、的可行性 72 使用方面的可行性  8 結(jié)論  2.項(xiàng)目開(kāi)發(fā)計(jì)劃：是為軟件項(xiàng)目實(shí)施方案制定出的具體計(jì)劃。項(xiàng)目開(kāi)發(fā)計(jì)劃應(yīng)提前給管理部門(mén)，并作為開(kāi)發(fā)階段評(píng)審的基礎(chǔ)。編制項(xiàng)目開(kāi)發(fā)計(jì)劃的止的是用文件的形式，把對(duì)于在開(kāi)發(fā)過(guò)程中各項(xiàng)工作的負(fù)責(zé)人員、開(kāi)發(fā)進(jìn)度、所需經(jīng)費(fèi)預(yù)算、所需的軟硬條件等問(wèn)題做出的安排記載下來(lái)，以便根據(jù)本計(jì)劃開(kāi)展和檢查項(xiàng)目的開(kāi)發(fā)工作。 其格式要求如下：  1 引言 11 編寫(xiě)目的 12 定義 13 參考資料  2

13、 項(xiàng)目概述 21 工作內(nèi)容 22 主要參加人員 23 產(chǎn)品 231 程序 232 方件 233 服務(wù) 234 非移交的產(chǎn)品 24 驗(yàn)收標(biāo)準(zhǔn) 25 完成項(xiàng)目的最遲期限 26 本計(jì)劃的批準(zhǔn)者和批準(zhǔn)日期  3 實(shí)施計(jì)劃 31 工作任務(wù)的分配與人員分工 32 接口人員 33 進(jìn)度 34 

14、預(yù)算 35 關(guān)鍵問(wèn)題  4 支持條件 41 計(jì)算機(jī)系統(tǒng)支持 42 需收用戶承擔(dān)的工作 43 由外單位提供的條件  5 專題計(jì)劃要點(diǎn)  3.開(kāi)發(fā)進(jìn)度月報(bào)：開(kāi)發(fā)進(jìn)度月報(bào)的編制目的是及時(shí)向有關(guān)部門(mén)匯報(bào)項(xiàng)目開(kāi)發(fā)的進(jìn)度和情況，以便及時(shí) 發(fā)現(xiàn)和處理開(kāi)發(fā)過(guò)程中出現(xiàn)的問(wèn)題，一般開(kāi)發(fā)進(jìn)度月報(bào)是以項(xiàng)目組單位每月編寫(xiě)的。如果被開(kāi)發(fā)的軟件系統(tǒng)規(guī)模比較大，整個(gè)工程項(xiàng)目被劃分給若干個(gè)分項(xiàng)目駔承擔(dān)，開(kāi)發(fā)進(jìn)度月報(bào)將以分項(xiàng)目為單位摟月編寫(xiě)。 其格式要求如下：&

15、#160;1 標(biāo)題  2 工程進(jìn)度與狀態(tài) 21 進(jìn)度 22 狀態(tài)  3 資源耗用與狀態(tài) 31 資源耗用 311 工時(shí) 313 機(jī)時(shí) 32 狀態(tài)  4 經(jīng)費(fèi)支出與狀態(tài) 41 經(jīng)費(fèi)支出 411 支持性費(fèi)用 412 設(shè)備購(gòu)置費(fèi) 42 狀態(tài)  5 下一個(gè)月的工作計(jì)劃 

16、 6 建議  4.項(xiàng)目開(kāi)發(fā)總結(jié)：軟件項(xiàng)目開(kāi)發(fā)完成之后，應(yīng)當(dā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)。項(xiàng)目開(kāi)發(fā)總結(jié)報(bào)告的編制是為了總結(jié)本項(xiàng)目開(kāi)發(fā)工作的經(jīng)驗(yàn)，說(shuō)明實(shí)際取得的開(kāi)發(fā)結(jié)果以及對(duì)整個(gè)開(kāi)發(fā)工作的各個(gè)方面的評(píng)價(jià)。 其格式要求如下：  1 引言 11 編寫(xiě)目的 12 背景 13 定義 14 參考資料  2 實(shí)際開(kāi)以結(jié)果&#

17、160;21 產(chǎn)品 22 主要功能和性能 23 基本流程 24 進(jìn)度 25 費(fèi)用  3 開(kāi)發(fā)工作評(píng)價(jià) 31 對(duì)生產(chǎn)效率的評(píng)價(jià) 32 對(duì)產(chǎn)品質(zhì)量的評(píng)價(jià) 33 對(duì)技術(shù)方法的評(píng)價(jià) 34 出錯(cuò)原因的分析  4 經(jīng)驗(yàn)與教訓(xùn)  5.模塊開(kāi)發(fā)卷宗：模塊開(kāi)發(fā)卷宗是在模塊開(kāi)發(fā)過(guò)程中逐步編寫(xiě)出來(lái)的，每完成一個(gè)模塊或一組密切相關(guān)的模塊的復(fù)制進(jìn)編寫(xiě)一份，應(yīng)該把所有的模塊開(kāi)

18、發(fā)卷宗匯集在一起。編寫(xiě)的目的是記錄和匯意低層次開(kāi)發(fā)的進(jìn)度和結(jié)果，經(jīng)便于對(duì)整個(gè)模塊開(kāi)發(fā)工作的管理和復(fù)審，并為將來(lái)的維護(hù)提供非常有用的技術(shù)信息。 1 標(biāo)題 2 模塊開(kāi)發(fā)情況表：其中模塊開(kāi)發(fā)情況表的格式如下表：模塊標(biāo)識(shí)符模塊的描述性名稱代碼設(shè)計(jì)（計(jì)劃開(kāi)始日期 實(shí)際開(kāi)始日期）模塊測(cè)試（計(jì)劃開(kāi)始日期 實(shí)際開(kāi)始日期）組裝測(cè)試（計(jì)劃開(kāi)始日期 實(shí)際開(kāi)始日期）代碼復(fù)查(日期/簽字)源代碼行數(shù)（預(yù)計(jì)/實(shí)際）目際模塊大?。A(yù)計(jì) 實(shí)際）項(xiàng)目負(fù)責(zé)人批準(zhǔn)(日期/簽字)3 功能說(shuō)明  4 設(shè)計(jì)說(shuō)明 

19、60;5 源代碼清單  6 測(cè)試說(shuō)明  7 復(fù)審的結(jié)論    三、軟件開(kāi)發(fā)測(cè)試文檔：概要測(cè)試計(jì)劃、詳細(xì)測(cè)試計(jì)劃、測(cè)試實(shí)施計(jì)劃、測(cè)試分析報(bào)告。1.概要測(cè)試計(jì)劃：是軟件項(xiàng)目實(shí)施計(jì)劃中的一項(xiàng)重要的內(nèi)容，應(yīng)當(dāng)在軟件開(kāi)發(fā)初期、即需求分析階段制訂。項(xiàng)計(jì)劃應(yīng)當(dāng)定義被測(cè)試對(duì)象和測(cè)試目標(biāo)，確定測(cè)試階段和測(cè)試周期的劃分；制訂測(cè) 試人員、軟硬件資源和測(cè)試進(jìn)度等方面的計(jì)劃，規(guī)定軟件測(cè)試方法，測(cè)試標(biāo)準(zhǔn)以及支持環(huán)境和測(cè)試工具。2.詳細(xì)測(cè)試計(jì)劃：是針對(duì)子系統(tǒng)在特定的測(cè)試階段所要進(jìn)行的測(cè)試工作制訂詳細(xì)計(jì)劃，

20、它詳細(xì)說(shuō)明規(guī)定了測(cè)試小組的各項(xiàng)測(cè)試任務(wù)，測(cè)試策略、任務(wù)分配和進(jìn)度安排等。3.測(cè)試實(shí)施計(jì)劃：測(cè)試人員的測(cè)試實(shí)施計(jì)劃是根據(jù)詳細(xì)計(jì)劃制訂的測(cè)試者的測(cè)試具體實(shí)施計(jì)劃。它規(guī)定了測(cè)試者在每一輪測(cè)試中負(fù)責(zé)測(cè)試的內(nèi)容，測(cè)試強(qiáng)度和工作進(jìn)度等。測(cè)試實(shí)施計(jì)劃是整個(gè)軟件測(cè)試的組成部分，是檢查測(cè)試實(shí)際執(zhí)行情況的重要依據(jù)。其格式要求如下： 1 引言  11 編寫(xiě)目的 12 背景 13 定義 14 參考資料  2 計(jì)劃  21 軟件說(shuō)明 22&#

21、160;測(cè)試內(nèi)容 23 測(cè)試231 進(jìn)度安排 232 條件 233 測(cè)試資料 234 測(cè)試培訓(xùn) 24 測(cè)試 3 測(cè)試設(shè)計(jì)說(shuō)明  31 測(cè)試 311 控制 312 輸入 313 輸出 314 過(guò)程 32 測(cè)試  4 評(píng)價(jià)準(zhǔn)則  41 范圍 42 數(shù)據(jù)整理

22、0;43 尺度  4.測(cè)試分析報(bào)告：測(cè)試工作完成以后，應(yīng)當(dāng)提交測(cè)試計(jì)劃情況說(shuō)明書(shū)，對(duì)測(cè)試結(jié)果加以分析，并提 出測(cè)試的結(jié)論性意見(jiàn)。其格式要求如下： 1 引言 11 編寫(xiě)目的 12 背景 13 定義 14 參考資料  2 測(cè)試概要  3 測(cè)試結(jié)果及發(fā)現(xiàn)  31 測(cè)試 132 測(cè)試 2  4 對(duì)軟件功能的結(jié)論

23、60; 41 功能 1 411 能力 412 限制42 功能 25 分析摘要  51 能力 52 缺陷和限制 53 建議 54 評(píng)價(jià)  6 測(cè)試資源消耗四、用戶文檔：用戶手冊(cè)、操作手冊(cè)。1.用戶手冊(cè)：用戶手冊(cè)的編制是要使用非專門(mén)術(shù)語(yǔ)的語(yǔ)言，充分地描述該軟件系統(tǒng)所具有的功能及基本的使用方法，使用戶（或潛在用戶）通過(guò)本手冊(cè)能夠了解該軟件的用途，并且能夠確定在什么情況下，如何使用它。

24、其格式要求如下： 1 引言  11 編寫(xiě)目的 12 背景 13 定義 14 參考資料  2 用途  21 功能 22 性能 221 精度 222 時(shí)間特性 223 靈活性 23 安全保密  3 運(yùn)行環(huán)境  31 硬設(shè)備 32 支持軟件 33

25、 數(shù)據(jù)結(jié)構(gòu)  4 使用過(guò)程  41 安裝與初始化 42 輸入 421 輸入數(shù)據(jù)的現(xiàn)實(shí)背景 422 輸入格式 423 輸入舉例 43 輸出 431 輸出數(shù)據(jù)的現(xiàn)實(shí)背景 432 輸出格式 433 輸出舉例 44 文卷查詢 45 出錯(cuò)處理和恢復(fù) 46 終端操作  2.操作手冊(cè)：操作手冊(cè)的編制是為了向操作人員提供該軟件每一個(gè)運(yùn)行的具體過(guò)程和有關(guān)知識(shí)，包括操作方法的細(xì)節(jié)。其格式要求如下：1 引言  11 編寫(xiě)目的 12 背景 13 定義 14 參考資料  2 軟件征述  21 軟件的結(jié)構(gòu)