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

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

2、就是 為了使用戶和軟件開發(fā)者雙方對該軟件的初始規(guī)定有一個共同的理解、并使之面成為 整個開發(fā)工作的基礎。其格式要求如下：  1 引言 11 編寫目的。 12 背景 13 定義  2 任務概述 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 設備 42 支持軟件 43 接口 44 控制  2、概要設計說明書：又稱系統(tǒng)設計說明書，這里所說的系統(tǒng)是指程序系統(tǒng)。編制的目的是說明對程序系統(tǒng)的設計考慮，包括程序系統(tǒng)的基本處理。流程、程序系統(tǒng)的組織 結

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

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

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

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

8、尚未解決的問題  4 程序 2設計說明 .    二、軟件開發(fā)管理文檔：可行性研究報告、項目開發(fā)計劃、開發(fā)進度月報、項目開發(fā)總結、模塊開發(fā)卷宗。 1.可行性研究報告：編寫目的是，說明該軟件開發(fā)項目的實現(xiàn)在技術、經(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 設備36 局限性  4 所建議的系統(tǒng) 41 對所建議系統(tǒng)的說明 42 處

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

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

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

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

14、預算 35 關鍵問題  4 支持條件 41 計算機系統(tǒng)支持 42 需收用戶承擔的工作 43 由外單位提供的條件  5 專題計劃要點  3.開發(fā)進度月報：開發(fā)進度月報的編制目的是及時向有關部門匯報項目開發(fā)的進度和情況，以便及時 發(fā)現(xiàn)和處理開發(fā)過程中出現(xiàn)的問題，一般開發(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 設備購置費 42 狀態(tài)  5 下一個月的工作計劃 

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

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

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

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

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

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

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

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

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

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