軟件開發文檔模板 （學習）

 1　可行性研究報告 
　　可行性研究報告的編寫目的是：說明該軟件開發項目的實如今技術、經濟和社會條件方面的可行性；評述爲了合理地達到開發目標而可能先擇的各類方案；說明論證所選定的方案。 
可行性研究報告的編寫內容要求以下： 
　　1.1　引言 
　　1.1.1　編寫目的 
　　1.1.2　背景 
　　1.1.3　定義 
　　1.1.4　參考資料 
　　1.2　可行性研究的前提 
　　1.2.1　要求 
　　1.2.2　目標 
　　1.2.3　條件、假定和限制 
　　1.2.4　進行可行性研究的方法 
　　1.2.5　評價尺度 
　　1.3　對現有系統的分析 
　　1.3.1　數據流程和處理流程 
　　1.3.2　工做負荷 
　　1.3.3　費用開支 
　　1.3.4　人員 
　　1.3.5　設備 
　　1.3.6　侷限性 
　　1.4　所建議的系統 
　　1.4.1　對所建議系統的說明 
　　1.4.2　數據流程各處理流程 
　　1.4.3　改進之處 
　　1.4.4　影響 
　　1.4.4.1　對象設備的影響 
　　1.4.4.2　對軟件的影響 
　　1.4.4.3　對用戶單位機構的影響 
　　1.4.4.4　對系統動行的影響 
　　1.4.4.5　對開發的影響 
　　1.4.4.6　對地點和設施的影響 
　　1.4.4.7　對經費開支的影響 
　　1.4.5　侷限性 
　　1.4.6　技術條件方面的可行性 
　　1.5　可選擇其餘系統方案 
　　1.5.1　可選擇的系統方案 1
　　1.5.2　可選擇的系統方案 2
　　 ……
　　1.6　投資及收益分析 
　　1.6.1　支出 
　　1.6.1.1　基本建設投資 
　　1.6.1.2　其餘一次性支出 
　　1.6.1.3　非一次性支出 
　　1.6.2　收益 
　　1.6.2.1　一次性收益 
　　1.6.2.2　非一次性收益 
　　1.6.2.3　不可定量的收益 
　　1.6.3　收益/投資比 
　　1.6.4　投資回收週期 
　　1.6.5　敏感性分析 
　　1.7　社會條件方面的可行性 
　　1.7.1　法律方面的可行性 
　　1.7.2　使用方面的可行性 
　　1.8　結論 
2 　項目開發計劃 
　　編制項目開發計劃的目的是用文件的形式，把對於在開發過程當中各項工做的負責人員、開發進度所需經費預算、所需軟、硬件條件等問題做出安排記載下來，以便根據本計劃開展和檢查本項目的開發工做。編制內容要求以下： 
　　2.1　引言 
　　2.1.1　編寫目的 
　　2.1.2　背景 
　　2.1.3　定義 
　　2.1.4　參考資料 
　　2.2　項目概述 
　　2.2.1　工做內容 
　　2.2.2　主要參加人員 
　　2.2.3　產品及成果 
　　2.2.3.1　程序 
　　2.2.3.2　文件 
　　2.2.3.3　服務 
　　2.2.3.4　非移交產品 
　　2.2.4　驗收標準 
　　2.2.5　完成項目的最遲期限 
　　2.2.6　本計劃的審查者與批准者 
　　2.3　實施總計劃 
　　2.3.1　工做任務的分解 
　　2.3.2　接口人員 
　　2.3.3　進度 
　　2.3.4　預算 
　　2.3.5　關鍵問題 
　　2.4　支持條件 
　　2.4.1　計算機系統支持 
　　2.4.2　須要用戶承擔的工做 
　　2.4.3　需由外單位提供的條件 
　　2.5　專題計劃要點 
3 　軟件需求說明書 
　　軟件需求說明書的編制是爲了使用戶的軟件開發者雙方對該軟件的起初規定有一個共同的理解，使之成爲整個開發工做的基礎。編制軟件需求說明書的內容要求以下： 
　　3.1　引言 
　　3.1.1　編寫的目的 
　　3.1.2　背景 
　　3.1.3　定義 
　　3.1.1　參考資料 
　　3.2　任務概述 
　　3.2.1　目標 
　　3.2.2　用戶的點 
　　3.2.3　假定與約束 
　　3.3　需求規定 
　　3.3.1　對功能的規定 
　　3.3.2　對性能的規定 
　　3.3.2.1　精度 
　　3.3.2.2　時間特性要求 
　　3.3.2.3　靈活性 
　　3.3.3　輸入輸出要求 
　　3.3.4　數據管理能力的要求 
　　3.3.5　故障處理要求 
　　3.3.6　其它的專門的要求 
　　3.4　運行環境規定 
　　3.4.1　設備 
　　3.4.2　支持軟件 
　　3.4.3　接口 
　　3.4.4　控制 
4 　數據需求說明書 
　　數據要求說明書的編制目的是爲了向整個開發時期提供關於處理數據的描述和數據採集要求的技術信息。編制數據要求說明書的內容要求以下： 
　　4.1　引言 
　　4.1.1　編寫目的 
　　4.1.2　背景 
　　4.1.3　定義 
　　4.1.4　參考資料 
　　4.2　數據的邏輯描述 
　　4.2.1　靜態數據 
　　4.2.2　動態輸入數據 
　　4.2.3　動態輸出數據 
　　4.2.4　內部生成數據 
　　4.2.5　數據約定 
　　4.3　數據的採集 
　　4.3.1　要求和範圍 
　　4.3.2　輸入的承擔者 
　　4.3.3　處理 
　　4.3.4　影響 
5 　概要設計說明書 
　　概要設計說明書可稱做系統設計說明書，這裏說的系統是指程序系統，編制的目的是說明對程序的系統的設計考慮，包括程序系統的基本處理流程、程序系統的組織結構、模塊劃分、功能分配、接口設計、運行設計、數據結構設計和出錯處理設計等，爲程序的詳細設計提供基礎。編制概要設計說明書的內容要求以下： 
　　5.1　引言 
　　5.1.1　編寫目的 
　　5.1.2　背景 
　　5.1.3　定義 
　　5.1.4　參考資料 
　　5.2　整體設計 
　　5.2.1　需求規定 
　　5.2.2　運行環境 
　　5.2.3　基本設計概念和處理流程 
　　5.2.4　結構 
　　5.2.5　功能需求與程序的關係 
　　5.2.6　人工處理過程 
　　5.2.7　還沒有解決的問題 
　　5.3　接口設計 
　　5.3.1　用戶接口 
　　5.3.2　內部接口 
　　5.3.3　外部接口 
　　5.4　運行設計 
　　5.4.1　運行模塊組合 
　　5.4.2　運行控制 
　　5.4.3　運行時間 
　　5.5　系統數據結構設計 
　　5.5.1　邏輯結構設計要點 
　　5.5.2　物理結構設計要點 
　　5.5.3　數據結構與程序的關係 
　　5.6　系統出錯處理設計 
　　5.6.1　出錯信息 
　　5.6.2　補救措施 
　　5.6.3　系統維護設計 
6 　詳細設計說明書 
　　詳細說明書可稱做程序設計說明書。編制目的是說明一個軟件系統各個層次中的每個程序（每一個模塊或子程序）的設計考慮，若是一個軟件系統比較簡單，層次不多，本文件能夠不單獨編寫，有關內容合併概要設計說明書。對詳細設計說明書的內容要不得要求以下： 
　　6.1　引言 
　　6.1.1 編寫目的 
　　6.1.2 背景 
　　6.1.3 定義 
　　6.1.4 參考資料 
　　6.2 程序系統的組織結構 
　　6.3 程序1（標識符）設計說明 
　　6.3.1 程序描述 
　　6.3.2 功能 
　　6.3.3 性能 
　　6.3.4 輸入項 
　　6.3.5 輸出項 
　　6.3.6 算法 
　　6.3.7 流程邏輯 
　　6.3.8 接口 
　　6.3.9 存儲分配 
　　6.3.10 註釋設計 
　　6.3.11 限制條件 
　　6.3.12 測試計劃 
　　6.3.13 還沒有解決的問題 
　　6.4 程序2（標識符）設計說明 
　　 ……
7　數據庫設計說明書 
　　數據庫設計說明書的編制目的是對於設計中的數據庫全部標識、邏輯結構和理結構做出具體的設計規定。其內容要求以下： 
　　7.1　引言 
　　7.1.1　編寫目的 
　　7.1.2　背景 
　　7.1.3　定義 
　　7.1.4　參考資料 
　　7.2　外部設計 
　　7.2.1　標識符和狀態 
　　7.2.2　使用它的程序 
　　7.2.3　約定 
　　7.2.4　專門指導 
　　7.2.5　支持軟件 
　　7.3　結構設計 
　　7.3.1　概念結構設計 
　　7.3.2　邏輯結構設計 
　　7.3.3　理結構設計 
　　7.4　運用設計 
　　7.4.1　數據字典設計 
　　7.4.2　安全保密設計 
8 　用戶手冊 
　　用戶手冊的編制是要使用非專門術語的語言，充分地描述該軟件系統工程所具備的功能及基本的使用方法。使用戶（或潛在用戶）經過本手冊可以瞭解該軟件的用途，而且可以肯定在什麼狀況下，如何使用它。具體的內容要求以下： 
　　8.1　引言 
　　8.1.1　編寫目的 
　　8.1.2　背景 
　　8.1.3　定義 
　　8.1.4　參考資料 
　　8.2　用途 
　　8.2.1　功能 
　　8.2.2　性能 
　　8.2.2.1　精度 
　　8.2.2.2　時間特性 
　　8.2.2.3　靈活性 
　　8.2.3　安全保密 
　　8.3　運行環境 
　　8.3.1　硬設備 
　　8.3.2　支持軟件 
　　8.3.3　數據結構 
　　8.4　使用過程 
　　8.4.1　安裝與初始化 
　　8.4.2　輸入 
　　8.4.2.1　輸入數據的現實背景 
　　8.4.2.2　輸入格式 
　　8.4.2.3　輸入舉例 
　　8.4.3　輸出 
　　8.4.3.1　輸出數據的現實背景 
　　8.4.3.2　輸出格式 
　　8.4.3.3　輸出舉例 
　　8.4.4　文卷查詢 
　　8.4.5　出錯處理與恢復 
　　8.4.6　終端操做 
9 　操做手冊 
操做手冊的編制是爲了向操做人中提供該軟件每個運行的具體過程和有關知識，包括操做方法的細節。具體的內容要求以下： 
　　9.1　引言 
　　9.1.1　編寫目的 
　　9.1.2　背景 
　　9.1.3　定義 
　　9.1.2　參考資料 
　　9.2　軟件概述 
　　9.2.1　軟件的結構 
　　9.2.2　程序表 
　　9.2.3　文卷表 
　　9.3　安裝與初始化 
　　9.4　運行說明 
　　9.4.1　運行表 
　　9.4.2　運行步驟 
　　9.4.3　運行1（標識符）說明 
　　9.4.3.1　運行控制 
　　9.4.3.2　操做信息 
　　9.4.3.3　輸入-輸出文卷 
　　9.4.3.4　輸出文段 
　　9.4.3.5　輸出文段的複製 
　　9.4.3.6　啓動恢復過程 
　　9.4.4　運行2（標識符）說明 
　　9.5　很是規過程 
　　9.6　遠程操做 
10 　模塊開發卷宗 
　　模塊開發卷宗是在模塊開發過程當中逐步編寫出來的，每完成一個模塊或一級密切相關的模塊的複審時編寫一份，應該把全部的模塊開發卷宗聚集在一塊兒。編寫的目的是記錄和彙總低層次開發的進度和結果，以便於對整個模塊開發工做的管理和複審，併爲未來的維護提供很是有用的技術信息。具體的內容要求以下： 
　　10.1　標題 
　　10.2　模塊開發狀況表 
　　10.3　功能說明 
　　10.4　設計說明 
　　10.5　源代碼清單 
　　10.6　測試說明 
　　10.7　複審的結論 
11 　測試計劃 
　　11.1　引言 
　　11.1.1　編寫目的 
　　11.1.2　背景 
　　11.1.3　定義 
　　11.1.4　參考資料 
　　11.2　計劃 
　　11.2.1　軟件說明 
　　11.2.2　測試內容 
　　11.2.3　測試1（標識符） 
　　11.2.3 .1　進度安排 
　　11.2.3 .2　條件 
　　11.2.3 .3　測試資料 
　　11.2.3 .4　測試培訓 
　　11.2.4　測試2（標識符） 
　　 ……
　　11.3　測試設計說明 
　　11.3.1　測試1（標識符） 
　　11.3.1 .1　控制 
　　11.3.1 .2　輸入 
　　11.3.1 .3　輸出 
　　11.3.1 .4　過程 
　　11.3.2　測試2（標識符） 
　　 ……
　　11.4　評價準則 
　　11.4.1　範圍 
　　11.4.2　數據整理 
　　11.4.3　尺度 
12 　測試分析報告 
　　測試分析報告的編寫是爲了把組裝測試和確認測試的結果、發現及分析寫成文件加發記載，具體的編寫內容要求以下： 
　　12.1　引言 
　　12.1.1　編寫目的 
　　12.1.2　背景 
　　12.1.3　定義 
　　12.1.4　參考資料 
　　12.2　測度概要 
　　12.3　測試結果及發現 
　　12.3.1　測試1（標識符） 
　　12.3.2　測試2（標識符） 
　　 ……
　　12.4　對軟件功能的結論 
　　12.4.1　功能1（標識符） 
　　12.4.1 .1　能力 
　　12.4.1 .2　限制 
　　12.4.2　功能2（標識符） 
　　 ……
　　12.5　分析摘要 
　　12.5.1　能力 
　　12.5.2　缺陷和限制 
　　12.5.3　建議 
　　12.5.4　評價 
　　12.6　測試資源消耗 
13 　開發進度月報 
　　開發進度月報的編制目的是及時向有關管理部門彙報項目開發的進展和狀況，以便函及時發現或處理開發過程當中出現的問題。通常地，開發進度月報是以項目組爲單位每個月編寫的。若是被開發的軟件系統規模比較大，整個工程項目被劃分給若干個分項目組承擔，開發進度月報將以項目組爲單位按月編寫。具體的內容要求以下： 
　　13.1　標題 
　　13.2　工程進度與狀態 
　　13.2.1　進度 
　　13.2.2　狀態 
　　13.3　資源耗用與狀態 
　　13.3.1　資源耗用 
　　13.3.1 .1　工時 
　　13.3.1 .2　機時 
　　13.3.2　狀態 
　　13.4　經費支出與狀態 
　　13.4.1　經費支出 
　　13.4.1 .1　支持性費用 
　　13.4.1 .2　設備購置費 
　　13.4.2　狀態 
　　13.5　下個月的工做計劃 
　　13.6　建議 
14 　項目開發總結報告 
　　項目開發總結報告的編制是爲了總結本項目開發工做的經驗，說明實際取得的開發結果以及對整個開發工做的各個方面的評價。具體的內容要求以下： 
　　14.1　引言 
　　14.1.1　編寫目的 
　　14.1.2　背景 
　　14.1.3　定義 
　　14.1.4　參考資料 
　　14.2　實際開發結果 
　　14.2.1　產品 
　　14.2.2　主要功能和性能 
　　14.2.3　基本流程 
　　14.2.4　進度 
　　14.2.5　費用 
　　14.3　開發工做評價 
　　14.3.1　對生產效率的評價 
　　14.3.2　對產品質量的評價 
　　14.3.3　對技術方法的評價 
　　14.3.4　出錯緣由的分析 
　　14.4　經驗與教訓。