軟件開發文檔介紹

軟件開發文檔是軟件開發使用和維護過程當中的必備資料。它能提升軟件開發的效率，保證軟件的質量，並且在軟件的使用過程當中有指導、幫助、解惑的做用，尤爲在維護工做中，文檔是不可或缺的資料。

---

軟件開發文檔能夠分爲開發文檔和產品文檔兩大類。
開發文檔包括：《功能要求》、《投標方案》、《需求分析》、《技術分析》、《系統分析》、《數據庫文檔》、《功能函數文檔》、《界面文檔》、《編譯手冊》、《 QA 文檔》、《項目總結》等。
產品文檔包括：《產品簡介》、《產品演示》、《疑問解答》、《功能介紹》、 《技術白皮書》、《評測報告》。用戶文檔《安裝手冊》、《使用手冊》、《維護手冊》、 《用戶報告》、《銷售培訓》等。

開發文檔

• 《功能要求》 -- 來源於客戶要求和市場調查，是軟件開發中最先期的一個環節。客戶提出一個模糊的功能概念，或者要求解決一個實際問題，或者參照同類軟件的一個功能。有軟件經驗的客戶還會提供比較詳細的技術規範書，把他們的要求所有列表書寫在文檔中，必要時加以圖表解說。這份文檔是需求分析的基礎。
• 《投標方案》 -- 根據用戶的功能要求，通過與招標方溝通和確認，技術人員開始書寫《投標方案》，方案書通常包括如下幾個重要的章節： 前言 -- 項目背景、公司背景和業務、技術人員結構、公司的成功案例介紹等。 需求分析 -- 項目要求、軟件結構、功能列表、功能描述、注意事項等。 技術方案 -- 整體要求和指導思想、技術解決方案、軟件開發平臺、網絡結構體系等。 項目管理 -- 描述公司的軟件開發流程、工程實施服務、組織和人員分工、開發進度控制、軟件質量保證、項目驗收和人員培訓、軟件資料文檔等。 技術支持 -- 公司的技術支持和服務介紹、服務宗旨和目標、服務級別和響應時間、技術服務區域、技術服務期限、受權用戶聯繫人等。 系統報價 -- 軟、硬件平臺報價列表、軟件開發費用、系統維護費用等。 項目進度 -- 整個項目的進度計劃，包括簽署合同、項目啓動、需求分析、系統分析、程序開發、測試維護、系統集成、用戶驗收、用戶培訓等步驟的時間規劃。
• 《需求分析》 -- 包括產品概述、主要概念、操做流程、功能列表和解說、注意事項、系統環境等。以《功能要求》爲基礎，進行詳細的功能分析 ( 包括客戶提出的要求和根據開發經驗建議的功能 ) ，列出本產品是什麼，有什麼特殊的概念，包括哪些功能分類，須要具有什麼功能，該功能的操做如何，實現的時候該注意什麼細節，客戶有什麼要求，系統運行環境的要求等。這裏的功能描述跟之後的使用手冊是一致的。
• 《技術分析》 -- 包括技術選型、技術比較、開發人員、關鍵技術問題的解決、技術風險、技術升級方向、技術方案評價，競爭對手技術分析等。以《需求分析》爲基礎，進行詳細的技術分析 ( 產品的性能和實現方法 ) ，列出本項目須要使用什麼技術方案，爲何，有哪些技術問題要解決 ，估計開發期間會碰到什麼困難，技術方案之後如何升級，對本項目的技術有什麼評價等。
• 《系統分析》 -- 包括功能實現、模塊組成、功能流程圖、函數接口、數據字典、軟件開發須要考慮的各類問題等。以《需求分析》爲基礎，進行詳細的系統分析 ( 產品的開發和實現方法 ) ，估計開發期間須要把什麼問題說明白，程序員根據《系統分析》，開始在項目主管的帶領下進行編碼。
• 《數據庫文檔》 -- 包括數據庫名稱、表名、字段名、字段類型、字段說明、備註、字段數值計算公式等。以《系統分析》爲基礎，進行詳細的數據庫設計。必要時能夠用圖表解說，特別是關係數據庫。
• 《功能函數文檔》 -- 包括變量名、變量初植、功能，函數名，參數，如何調用、備註、注意事項等。以《系統分析》爲基礎，進行詳細的說明，列出哪一個功能涉及多少個函數，以便之後程序員修改、接手和擴展。
• 《界面文檔》 -- 包括軟件外觀、界面素材、編輯工具、文件名、菜單、按鈕和其它界面部件的要求，這裏與軟件完成後的運行界面是一致的。
• 《編譯手冊》 -- 包括服務器編譯環境、操做系統、編譯工具、 GNU 的 C++ 編譯器版本信息、目錄說明、程序生成、源程序文件列表、 Makefile 配置及其相關程序的對應關係列表。客戶端的編譯過程、編譯結果、編譯示例、編譯環境、操做系統、編譯工具、源文件列表和製做安裝程序的過程。
• 《 QA 文檔》 -- 包括產品簡介、產品原理、產品功能列表、功能描述、功能流程、執行結果、數據庫結構、測試要求等，提供給軟件測試人員使用。
• 《項目總結》 -- 包括項目簡介、項目參與人員和開發時間、項目風險管理過程、項目功能列表、項目結構特色、技術特色、對項目的升級建議、對之後的項目的建議、人員素質狀況等。

產品文檔

• 《產品簡介》 -- 包括公司背景、產品概念、適用範圍、產品功能、功能特色、運行要求和公司聯繫地址。
• 《產品演示》 -- 包括公司簡介、產品背景、產品描述、產品特色、產品做用、適用範圍、使用分析、功能模塊、解決問題、合做夥伴、成功案例等。通常用 Power point 或者 VCD 錄製軟件實現。
• 《疑問解答》 -- 列出用戶關心的問題和處理方法。用於解答軟件的操做功能和解決用戶的疑難問題。
• 《功能介紹》 -- 以《需求分析》爲書寫基礎，包括軟件介紹、軟件結構、功能列表、功能描述和公司聯繫地址。
• 《技術白皮書》 -- 以《技術分析》爲書寫基礎，包括功能實現、技術選型、關鍵技術問題的解決、技術方案特色、技術升級方向等。
• 《評測報告》 -- 第三方權威評測報告。包括評測目的、評測範圍、評測環境、評測內容、實測數據、性能表現、結果分析和評測總結等。
• 《安裝手冊》 -- 包括系統環境、運行平臺、產品安裝過程、初始環境設置、安裝記錄等。
• 《使用手冊》 -- 包括產品簡介、功能列表、功能描述和解釋、功能操做、客戶服務和聯繫方式等。
• 《維護手冊》 -- 包括產品簡介、系統須知、初始環境設置、系統配置、數據管理和備份、技術問題解答和聯繫方式等。
• 《用戶報告》 -- 包括產品簡介、購買時間、使用目的、使用時間、使用地點、實施過程、出現問題和解決、產品總結和建議等。
• 《銷售培訓》 -- 包括項目簡介、產品功能、產品特色、商業優點、系統運行環境、適用範圍、目標客戶等。

軟件開發文檔

第1、需求分析文檔

• 什麼是用戶需求分析文檔呢？也就是在和客戶進行溝通時，把用戶所要求的信息記錄下來，根據用戶的要求進行需求分析，規劃出咱們要開發的軟件所要實現哪些功能。

第2、概要設計文檔

• 概要設計：顧名思義，就是對咱們所要開發的軟件進行一個總體的歸納，把這個軟件所包含的功能模塊做一個設計，之後咱們在開發的時候就有目標，有方向了。

第3、系統設計文檔

• 系統設計：就是對概要的一個詳細的實施，就是分析咱們所要開發軟件各大功能模塊中所包含的小模塊，把這些小模塊都一一列舉出來，而後再對軟件開發人員進行有條理的進行開發任務的分配。

第4、詳細設計文檔

• 詳細設計文檔：主要是把咱們每一個小模塊，小功能的業務邏輯處理用文字的方式表達出來，讓程序員在編碼的時候有一個依據和參照；同時，在進行詳細文檔設計的時候，有的軟件公司也會根據不一樣的項目做出相應的《軟件開發代碼規範》性文檔。以保障咱們所作工做的統一性。

第5、軟件測試文檔

• 當咱們參照軟件詳細設計文檔編碼完成後，接着就會根據咱們所實現的功能，進行軟件測試文檔的編寫；大多測試文檔有兩類，一類是軟件單體測試文檔，一類是軟件結合測試文檔；顧名思義，單體測試：就是對軟件中每一個小的方法，一個獨立的方法進行測試的文檔；結合測試：就是把多個功能模塊組合到一塊兒進行測試，主要是爲了檢測每一個功能模塊以前的交互性和功能的結合實現性。

第6、軟件完成後的總結匯報型文檔

• 無論所開發軟件的規模大小，在一個軟件開發結束後，咱們都會把開發過中的問題和項目開發總結一塊兒記錄下來，以防之後在開發過程當中再有相似問題出現，提升咱們的開發效率。

根據軟件開發公司的規模、標準和客戶的需求不一樣，開發文檔的種類和數量也不一樣，我在這裏和你們討論的軟件開發相關文檔都是最基礎的。在軟件行業有一句話：一個軟件可否順利的完成而且功能是否完善，重要是看這個軟件有多少文檔。軟件開發文檔是一個軟件的支柱，若是你的開發文檔漏洞百出，那麼你所開發出來的軟件也不可能會好；開發文檔的好壞能夠直接影響到所開發出來軟件的成功與否。