前言
在開發項目的過程中，我深刻的意識到，文檔存在的意義並不是無用的報告，簡潔明瞭的文檔不光能記錄你當下所做的，還能在繁重的工作中分神思考下一步該做什麼時爲你節約精力，並且在項目週期內，使整個項目保持一致性。所以，軟件開發文檔的編寫是很有必要的。我參考網上的資料，結合自己項目開發時的心得，分享一些經驗。
文檔類型
在項目開發過程中，應該按要求編寫好十三種文檔，文檔編寫要求具有針對性、精確性、清晰性、完整性、靈活性、可追溯性。同時依照項目人員的角色劃分，完成不同類型的文檔。以下排序並未嚴格按照時間排序。
類型說明
可行性分析報告（產品人員）
可行性研究報告的編寫目的是：說明該軟件開發項目的實現在技術、經濟和社會條件方面的可行性；評述爲了合理達到開發目標而可能選擇的各種方案；實施方案的利弊；說明並論證所選定的方案。
項目開發計劃（產品人員）
軟件項目開發計劃即爲軟件項目實施方案制定出的具體計劃。項目開發計劃應提前給管理部門，並作爲開發階段評審的基礎。編寫項目開發計劃的目的是用文件的形式，把對於在開發過程中各項工作的負責人員、開發進度、所需經費預算、所需的軟硬條件等問題做出的安排記載下來，以便根據本計劃開展和檢查項目的開發工作。
軟件需求說明書（產品人員）
軟件需求說明書也稱爲軟件規格說明。該說明書對所開發軟件的功能、性能、用戶界面及運行環境等做出詳細的說明。它是用戶與開發人員雙方對軟件需求取得共同理解基礎上達成的協議，也是實施開發工作的基礎。軟件需求說明書的編寫目的就是爲了使用戶和軟件開發者雙方對該軟件的初需求有一個共同的理解，並使之成爲整個開發工作的基礎。
概要設計說明書 （開發人員）
概要設計說明書又可稱系統設計說明書，這裏所說的系統是指程序系統。編寫的目的是說明對程序系統的設計考慮，包括程序系統的基本處理。流程、程序系統的組織結構、模塊劃分、功能分配、接口設計。運行設計、數據結構設計和出錯處理設計等，爲程序的詳細設計提供基礎。
詳細設計規格說明書（開發人員）
詳細設計說明書又可稱程序設計說明書。編寫目的是說明一個軟件系統各個層次中的每一個程序（每人模塊或子程序）的設計考慮。如果項目比較簡單，層次較少，本文件可以不單獨編寫，有關內容合併入概要設計說明書。
用戶操作手冊（產品人員）
用戶操作手冊的編寫是要使用非專門術語的語言，充分地描述該軟件系統所具有的功能及基本的使用方法，提供該軟件每一個運行的具體過程和有關知識，包括操作方法的細節。使用戶（或潛在用戶）通過本手冊能夠了解該軟件的用途，並且能夠確定在什麼情況下，如何使用它。
測試計劃（測試人員）
測試計劃是軟件項目實施計劃中的一項重要的內容，應當在軟件開發初期、即需求分析階段制訂。測試計劃應當定義被測試對象和測試目標，確定測試階段和測試周期的劃分；制訂測試人員、軟硬件資源和測試進度等方面的計劃，規定軟件測試方法，測試標準以及支持環境和測試工具。針對子系統在特定的測試階段所要進行的測試工作制訂詳細計劃，它詳細說明規定了測試小組的各項測試任務，測試策略、任務分配和進度安排等。
測試分析報告（測試人員）
測試工作完成以後，應當提交測試計劃情況說明書，對測試結果加以分析，並提出測試的結論性意見。
開發進度月報（開發人員）
開發進度月報的編寫目的是及時向有關部門彙報項目開發的進度和情況，以便及時發現和處理開發過程中出現的問題，一般，開發進度月報是以項目組單位每月編寫的。如果被開發的軟件系統規模比較大，整個工程項目被劃分給若干個分項目駔承擔，開發進度月報將以分項目爲單位每月編寫。
項目開發總結報告（產品人員）
軟件項目開發完成之後，應當與項目實施計劃對照，總結實際執行的情況，如進度、成果、資源利用、成本和投入的人力。此外，還需對開發工作做出評價，總結經驗和教訓。項目開發總結報告的編寫是爲了總結本項目開發工作的經驗，說明實際取得的開發結果以及對整個開發工作的各個方面的評價。
軟件維護手冊（開發人員）
主要包括軟件系統說明、程序模塊說明、操作環境、支持軟件的說明、維護 過程的說明，便於軟件的維護。
軟件問題報告（測試人員）
指出軟件問題的登記情況，如日期、發現人、狀態、問題所屬模塊等，爲軟件修改提供準備文檔。
軟件修改報告（開發人員）
軟件產品投入運行以後，發現了需對其進行修正、更改等問題，應將存在的問題、修改的考慮以及修改的影響作出詳細的描述，提交審批。
總結
根據項目的規模大小，以及人員構成，對所需要的文檔進行編寫，將大大提高項目開發的效率及規範程度。
項目開發文檔編寫規範模板：下載模板
