軟件文檔摘錄

內容摘自：http://www.php100.com/html/dujia/2015/0306/8727.html

軟件文檔能夠分爲開發文檔和產品文檔兩大類：
開發文檔包括：《功能要求》、《投標方案》、《需求分析》、《技術分析》、《系統分析》、《數據庫文檔》、《功能函數文檔》、《界面文檔》、《編譯手冊》、《QA文檔》、《項目總結》等。

產品文檔包括：《產品簡介》、《產品技術白皮書》、《評測報告》、《安裝手冊》、《使用手冊》、《維護手冊》、 《用戶報告》、《銷售培訓》等。
 

1、開發文檔

1. 《功能要求》——來源於客戶要求和市場調查，是軟件開發中最先期的一個環節。客戶提出一個模糊的功能概念，或者要求解決一個實際問題，又或者是參照同類軟件的一個功能。有軟件經驗的客戶還會提供比較詳細的技術規範書，把他們的要求所有列表書寫在文檔中，必要時加以圖表解說。這份文檔是需求分析的基礎。

2. 《投標方案》——根據用戶的功能要求，通過與招標方溝通和確認，技術人員開始書寫《投標方案》，方案書通常包括前言、需求分析、技術方案、項目管理、技術支持、系統報價、項目進度等。

3. 《需求分析》——包括產品概述、主要概念、操做流程、功能列表、注意事項、系統環境等。以《功能要求》爲基礎，進行詳細的功能分析，列出本產品是什麼，有什麼特殊的概念，包括那些功能分類，須要具有什麼功能，該功能的操做如何，實現的時候該注意什麼細 節，客戶有什麼要求，系統運行環境的要求等。這裏的功能描述跟之後的使用手冊是一致的。

4. 《技術分析》——包括技術選型、技術比較、開發人員、關鍵技術問題的解決、技術風險、技術升級方向、技術方案評價，競爭對手技術分析等。以《需求分析》爲基礎，進行詳細的技術分析（產品的性能和實現方法），列出本項目須要使用什麼技術方案，爲何，有哪些技術問題要解決 ，估計開發期間會碰到什麼困難，技術方案之後如何升級，對本項目的技術有什麼評價等。

5. 《系統分析》——包括功能實現、模塊組成、功能流程圖、函數接口、數據字典、軟件開發須要考慮的各類問題等。以《需求分析》爲基礎，進行詳細的系統分析（產品的開發和實現方法），程序員根據《系統分析》，開始在項目主管的帶領下進行編碼工做。

6. 《數據庫文檔》——包括數據庫名稱、表名、字段名、字段類型、字段說明、備註、字段數值計算公式等。以《系統分析》爲基礎，進行詳細的數據庫設計，必要時能夠用圖表解說，特別是關係數據庫。

7. 《功能函數文檔》——包括變量名、變量初植、功能、函數名、參數、如何調用、備註、注意事項等。以《系統分析》爲基礎，進行詳細的說明，列出哪一個功能涉及多少個函數，以便之後程序員修改、接手和擴展。

8. 《界面文檔》——包括軟件外觀、界面素材、編輯工具、文件名、菜單、按鈕和其它界面部件的要求，這裏與軟件完成後的運行界面是一致的。

9. 《編譯手冊》——包括服務器編譯環境、操做系統、編譯工具、編譯器版本信息、目錄說明、程序生成、源程序文件列表、Makefile配置及其相關程序的對應關係列表。客戶端的編譯過程、編譯結果、編譯示例、編譯環境、操做系統、編譯工具、源文件列表和製做安裝程序的過程。

10. 《QA文檔》——包括產品簡介、產品原理、產品功能列表、功能描述、功能流程、執行結果、數據庫結構、測試要求等，提供給軟件測試人員使用。

11. 《項目總結》——包括項目簡介、項目參與人員和開發時間、項目風險、管理過程、項目功能列表、項目結構特色、技術特色、對項目的升級建議、對之後的項目的建議、人員工做狀況等。
 

2、產品文檔

1. 《產品簡介》——包括公司背景、產品概念、適用範圍、產品功能、功能特色、運行要求和公司聯繫地址等。

2. 《產品演示》——包括公司簡介、產品背景、產品描述、產品特色、產品做用、適用範圍、使用分析、功能模塊、解決問題、合做夥伴、成功案例等。通常用Powerpoint或者視頻錄製軟件實現。

3. 《疑問解答》——列出用戶關心的問題和處理方法，用於解答軟件的操做功能和解決用戶的疑難問題。

4. 《功能介紹》——以《需求分析》爲書寫基礎，包括軟件介紹、軟件結構、功能列表、功能描述等。

5. 《技術白皮書》——以《技術分析》爲書寫基礎，包括功能實現、技術選型、關鍵技術問題的解決、技術方案特色、技術升級方向等。

6. 《評測報告》——第三方的權威評測報告。包括評測目的、評測範圍、評測環境、評測內容、實測數據、性能表現、結果分析和評測總結等。

7. 《安裝手冊》——包括系統環境、運行平臺、產品安裝過程、初始環境設置、安裝記錄等。

8. 《使用手冊》——包括產品簡介、功能列表、功能描述和解釋、功能操做、客戶服務和聯繫方式等。

9. 《維護手冊》——包括產品簡介、系統須知、初始環境設置、系統配置、數據管理和備份、技術問題解答和聯繫方式等。

10. 《用戶報告》——包括產品簡介、購買時間、使用目的、使用時間、使用地點、實施過程、出現問題和解決、產品總結和建議等。

11.《銷售培訓》——包括項目簡介、產品功能、產品特色、商業優點、系統運行環境、適用範圍、目標客戶等。