程序員文檔結構

『壹』 程序員喜歡什麼樣的需求文檔

程序員實際上並不需要這個文本的需求供認書，程序員喜歡「圖片」，文檔的文本應該是產品學生在腦子里思考，而不應該直接把這個想法描述成文字。
程序員需要的是一個清晰的交互圖,在關鍵位置的交互圖顯示,有一些邊界條件,交互圖不需要使用亂七八糟工具輸出,一張紙和鉛筆描述清晰,但恢復需求描述的所有元素就可以了,雖然沒有UI設計,但程序員可以開始開發演示。
一、產品介紹和行業簡介。首先，給程序員簡單介紹一下產品的價值，比如產品的作用，產品可以提供的服務，以及產品相對於競爭對手的優勢。還要介紹產品的目標用戶和使用場景。第二點是簡要說明行業的現狀，未來的趨勢是什麼，同行業競爭對手的情況如何?

二是產品的介紹。第一，實體關系圖很重要。當您將產品從0變成1時，為了使資料庫開發人員更快地了解您的產品，實體關系圖(e-r圖)將發揮很大的作用，資料庫開發人員可以參考圖來做數據表結構設計。
第二是用戶角色表的訪問。當涉及到角色和許可權時，需要一個全面的角色許可權表單來促進開發人員的參考。第三是業務流程圖。通過業務流程流程圖，可以從總體方向了解產品的整體邏輯，通過拆卸業務流程流程圖得到流程流程圖。

三是各種細節問題。產品的要求、功能和交互指示。寫功能描述，交互說明，不能漏掉一些細節，導致邏輯不嚴謹。可以從以下幾個方面來考慮，它會讓你更全面地思考:欄位，欄位描述，數據源；先決條件，排序機制，刷新機制；狀態流(頁面可能有多個狀態，需要解釋)；交互操作(正常操作，異常操作)

『貳』 軟體開發文檔的分類

1. 《功能要求》 -- 來源於客戶要求和市場調查，是軟體開發中最早期的一個環節。客戶提出一個模糊的功能概念，或者要求解決一個實際問題，或者參照同類軟體的一個功能。有軟體經驗的客戶還會提供比較詳細的技術規范書，把他們的要求全部列表書寫在文檔中，必要時加以圖表解說。這份文檔是需求分析的基礎。
2. 《投標方案》 -- 根據用戶的功能要求，經過與招標方溝通和確認，技術人員開始書寫《投標方案》，方案書一般包括以下幾個重要的章節： 前言 -- 項目背景、公司背景和業務、技術人員結構、公司的成功案例介紹等。 需求分析 -- 項目要求、軟體結構、功能列表、功能描述、注意事項等。 技術方案 -- 總體要求和指導思想、技術解決方案、軟體開發平台、網路結構體系等。 項目管理 -- 描述公司的軟體開發流程、工程實施服務、組織和人員分工、開發進度控制、軟體質量保證、項目驗收和人員培訓、軟體資料文檔等。 技術支持 -- 公司的技術支持和服務介紹、服務宗旨和目標、服務級別和響應時間、技術服務區域、技術服務期限、授權用戶聯系人等。 系統報價 -- 軟、硬體平台報價列表、軟體開發費用、系統維護費用等。 項目進度 -- 整個項目的進度計劃，包括簽署合同、項目啟動、需求分析、系統分析、程序開發、測試維護、系統集成、用戶驗收、用戶培訓等步驟的時間規劃。
3. 《需求分析》 -- 包括產品概述、主要概念、操作流程、功能列表和解說、注意事項、系統環境等。以《功能要求》為基礎，進行詳細的功能分析 ( 包括客戶提出的要求和根據開發經驗建議的功能 ) ，列出本產品是什麼，有什麼特殊的概念，包括哪些功能分類，需要具備什麼功能，該功能的操作如何，實現的時候該注意什麼細節，客戶有什麼要求，系統運行環境的要求等。這里的功能描述跟以後的使用手冊是一致的。
4. 《技術分析》 -- 包括技術選型、技術比較、開發人員、關鍵技術問題的解決、技術風險、技術升級方向、技術方案評價，競爭對手技術分析等。以《需求分析》為基礎，進行詳細的技術分析 ( 產品的性能和實現方法 ) ，列出本項目需要使用什麼技術方案，為什麼，有哪些技術問題要解決 ，估計開發期間會碰到什麼困難，技術方案以後如何升級，對本項目的技術有什麼評價等。
5. 《系統分析》 -- 包括功能實現、模塊組成、功能流程圖、函數介面、數據字典、軟體開發需要考慮的各種問題等。以《需求分析》為基礎，進行詳細的系統分析 ( 產品的開發和實現方法 ) ，估計開發期間需要把什麼問題說明白，程序員根據《系統分析》，開始在項目主管的帶領下進行編碼。
6. 《資料庫文檔》 -- 包括資料庫名稱、表名、欄位名、欄位類型、欄位說明、備注、欄位數值計算公式等。以《系統分析》為基礎，進行詳細的資料庫設計。必要時可以用圖表解說，特別是關系資料庫。
7. 《功能函數文檔》 -- 包括變數名、變數初值、功能，函數名，參數，如何調用、備注、注意事項等。以《系統分析》為基礎，進行詳細的說明，列出哪個功能涉及多少個函數，以便以後程序員修改、接手和擴展。
8. 《界面文檔》 -- 包括軟體外觀、界面素材、編輯工具、文件名、菜單、按鈕和其它界面部件的要求，這里與軟體完成後的運行界面是一致的。
9. 《編譯手冊》 -- 包括伺服器編譯環境、操作系統、編譯工具、 GNU 的 C++ 編譯器版本信息、目錄說明、程序生成、源程序文件列表、 Makefile 配置及其相關程序的對應關系列表。客戶端的編譯過程、編譯結果、編譯示例、編譯環境、操作系統、編譯工具、源文件列表和製作安裝程序的過程。
10. 《 QA 文檔》 -- 包括產品簡介、產品原理、產品功能列表、功能描述、功能流程、執行結果、資料庫結構、測試要求等，提供給軟體測試人員使用。
11. 《項目總結》 -- 包括項目簡介、項目參與人員和開發時間、項目風險管理過程、項目功能列表、項目結構特點、技術特點、對項目的升級建議、對以後的項目的建議、人員素質情況等。 1. 《產品簡介》 -- 包括公司背景、產品概念、適用范圍、產品功能、功能特點、運行要求和公司聯系地址。
2. 《產品演示》 -- 包括公司簡介、產品背景、產品描述、產品特點、產品作用、適用范圍、使用分析、功能模塊、解決問題、合作夥伴、成功案例等。一般用 Power point 或者 VCD 錄制軟體實現。
3. 《疑問解答》 -- 列出用戶關心的問題和處理方法。用於解答軟體的操作功能和解決用戶的疑難問題。
4. 《功能介紹》 -- 以《需求分析》為書寫基礎，包括軟體介紹、軟體結構、功能列表、功能描述和公司聯系地址。
5. 《技術白皮書》 -- 以《技術分析》為書寫基礎，包括功能實現、技術選型、關鍵技術問題的解決、技術方案特點、技術升級方向等。
6. 《評測報告》 -- 第三方權威評測報告。包括評測目的、評測范圍、評測環境、評測內容、實測數據、性能表現、結果分析和評測總結等。
7. 《安裝手冊》 -- 包括系統環境、運行平台、產品安裝過程、初始環境設置、安裝記錄等。
8. 《使用手冊》 -- 包括產品簡介、功能列表、功能描述和解釋、功能操作、客戶服務和聯系方式等。
9. 《維護手冊》 -- 包括產品簡介、系統須知、初始環境設置、系統配置、數據管理和備份、技術問題解答和聯系方式等。
10. 《用戶報告》 -- 包括產品簡介、購買時間、使用目的、使用時間、使用地點、實施過程、出現問題和解決、產品總結和建議等。
11. 《銷售培訓》 -- 包括項目簡介、產品功能、產品特點、商業優勢、系統運行環境、適用范圍、目標客戶等。 第一、需求分析文檔
用戶需求分析文檔是指在和客戶進行溝通時，把用戶所要求的信息記錄下來，根據用戶的要求進行需求分析，規劃出我們要開發的軟體所要實現哪些功能。
第二、概要設計文檔
概要設計：顧名思義，就是對我們所要開發的軟體進行一個整體的概括，把這個軟體所包含的功能模塊作一個設計，以後我們在開發的時候就有目標，有方向了。
第三、系統設計文檔
系統設計，就是對概要的一個詳細的實施，就是分析我們所要開發軟體各大功能模塊中所包含的小模塊，把這些小模塊都一一列舉出來，然後再對軟體開發人員進行有條理的進行開發任務的分配。
第四、詳細設計文檔
詳細設計文檔，主要是把我們每個小模塊，小功能的業務邏輯處理用文字的方式表達出來，讓程序員在編碼的時候有一個依據和參照；同時，在進行詳細文檔設計的時候，有的軟體公司也會根據不同的項目作出相應的《軟體開發代碼規范》性文檔。以保障我們所做工作的統一性。
第五、軟體測試文檔
當我們參照軟體詳細設計文檔編碼完成後，接著就會根據我們所實現的功能，進行軟體測試文檔的編寫；大多測試文檔有兩類，一類是軟體單體測試文檔，一類是軟體結合測試文檔；顧名思義，單體測試：就是對軟體中每個小的方法，一個獨立的方法進行測試的文檔；結合測試：就是把多個功能模塊組合到一起進行測試，主要是為了檢測每個功能模塊之前的交互性和功能的結合實現性。
第六、軟體完成後的總結匯報型文檔
不管所開發軟體的規模大小，在一個軟體開發結束後，我們都會把開發過中的問題和項目開發總結一起記錄下來，以防以後在開發過程中再有類似問題出現，提高我們的開發效率。
根據軟體開發公司的規模、標准和客戶的需求不同，開發文檔的種類和數量也不同，我在這里和大家討論的軟體開發相關文檔都是最基礎的；在軟體行業有一句話：一個軟體能否順利的完成並且功能是否完善，重要是看這個軟體有多少文檔，軟體開發文檔是一個軟體的支柱，如果你的開發文檔漏洞百出，那麼你所開發出來的軟體也不可能會好；開發文檔的好壞可以直接影響到所開發出來軟體的成功與否。