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

1、在軟件行業(yè)有一句話：一個軟件能否順當?shù)耐瓿刹⑶夜δ苁欠裢晟?，重要是看這個軟件有多少文檔，軟件開發(fā)文檔是一個軟件的支柱，假如你的開發(fā)文檔漏洞百出，那么你所開發(fā)出來的軟件也不行能會好；開發(fā)文檔的好壞可以直接影響到所開發(fā)出來軟件的成功與否。  一、軟件開發(fā)設(shè)計文檔：軟件開發(fā)文檔包括軟件需求說明書、數(shù)據(jù)要求說有書、概要設(shè)計說明書、具體設(shè)計說明書。 1、軟件需求說明書：也稱為軟件規(guī)格說明。 該說明書對所開發(fā)軟件的功能、性能、用戶 界面及運行環(huán)境等做出具體的說明。它是用戶與開發(fā)人員雙方對軟件需求取得共同理 解基礎(chǔ)上達成的協(xié)議，也是實施開發(fā)工作的基礎(chǔ)。軟件需求說明書的編制目的的

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

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

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

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

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

7、160;14 參考資料  2 程序設(shè)計系統(tǒng)的結(jié)構(gòu)  3 程序 1設(shè)計說明 31 程序描述 32 功能 33 性能 34 輸入項 35 輸出項 36 算法 37 流程規(guī)律 38 接口 39 存儲安排 310 注釋設(shè)計 311 限制條件 312 測試方案 313 

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

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

10、理流程和數(shù)據(jù)流程 43 改進之處 44 影響 441 結(jié)設(shè)備的影響 442 對軟件的影響 443 對用戶單位機構(gòu)的影響 444 對系統(tǒng)運行過程的影響 445 對開發(fā)的影響446 對地點和設(shè)備的影響 447 對經(jīng)費開支的影響  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 社會因素方面的可行性 71 法律方面

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

13、 項目概述 21 工作內(nèi)容 22 主要參與人員 23 產(chǎn)品 231 程序 232 方件 233 服務(wù) 234 非移交的產(chǎn)品 24 驗收標準 25 完成項目的最遲期限 26 本方案的批準者和批準日期  3 實施方案 31 工作任務(wù)的安排與人員分工 32 接口人員 33 進度 34 

14、預(yù)算 35 關(guān)鍵問題  4 支持條件 41 計算機系統(tǒng)支持 42 需收用戶擔當?shù)墓ぷ?#160;43 由外單位供應(yīng)的條件  5 專題方案要點  3.開發(fā)進度月報：開發(fā)進度月報的編制目的是準時向有關(guān)部門匯報項目開發(fā)的進度和狀況，以便準時 發(fā)覺和處理開發(fā)過程中消滅的問題，一般開發(fā)進度月報是以項目組單位每月編寫的。假如被開發(fā)的軟件系統(tǒng)規(guī)模比較大，整個工程項目被劃分給若干個分項目駔擔當，開發(fā)進度月報將以分項目為單位摟月編寫。 其格式要求如下：&

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

16、 6 建議  4.項目開發(fā)總結(jié)：軟件項目開發(fā)完成之后，應(yīng)當與項目實施方案對比，總牢固際執(zhí)行的狀況，如進度、 成果、資源利用、成本和投入的人力。此外，還需對開發(fā)工作做出評價，總結(jié)閱歷和教訓(xùn)。項目開發(fā)總結(jié)報告的編制是為了總結(jié)本項目開發(fā)工作的閱歷，說明實際取得的開發(fā)結(jié)果以及對整個開發(fā)工作的各個方面的評價。 其格式要求如下：  1 引言 11 編寫目的 12 背景 13 定義 14 參考資料  2 實際開以結(jié)果&#

17、160;21 產(chǎn)品 22 主要功能和性能 23 基本流程 24 進度 25 費用  3 開發(fā)工作評價 31 對生產(chǎn)效率的評價 32 對產(chǎn)品質(zhì)量的評價 33 對技術(shù)方法的評價 34 出錯緣由的分析  4 閱歷與教訓(xùn)  5.模塊開發(fā)卷宗：模塊開發(fā)卷宗是在模塊開發(fā)過程中逐步編寫出來的，每完成一個模塊或一組親密相關(guān)的模塊的復(fù)制進編寫一份，應(yīng)當把全部的模塊開

18、發(fā)卷宗匯合在一起。編寫的目的是記錄和匯意低層次開發(fā)的進度和結(jié)果，經(jīng)便于對整個模塊開發(fā)工作的管理和復(fù)審，并為將來的維護供應(yīng)格外有用的技術(shù)信息。 1 標題 2 模塊開發(fā)狀況表：其中模塊開發(fā)狀況表的格式如下表：模塊標識符模塊的描述性名稱代碼設(shè)計（方案開頭日期 實際開頭日期）模塊測試（方案開頭日期 實際開頭日期）組裝測試（方案開頭日期 實際開頭日期）代碼復(fù)查(日期/簽字)源代碼行數(shù)（估計/實際）目際模塊大?。ü烙?#160;實際）項目負責人批準(日期/簽字)3 功能說明  4 設(shè)計說明 

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

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

21、160;測試內(nèi)容 23 測試231 進度支配 232 條件 233 測試資料 234 測試培訓(xùn) 24 測試 3 測試設(shè)計說明  31 測試 311 把握 312 輸入 313 輸出 314 過程 32 測試  4 評價準則  41 范圍 42 數(shù)據(jù)整理

22、0;43 尺度  4.測試分析報告：測試工作完成以后，應(yīng)當提交測試方案狀況說明書，對測試結(jié)果加以分析，并提 出測試的結(jié)論性意見。其格式要求如下： 1 引言 11 編寫目的 12 背景 13 定義 14 參考資料  2 測試概要  3 測試結(jié)果及發(fā)覺  31 測試 132 測試 2  4 對軟件功能的結(jié)論

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

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

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