1、.：.；軟件文檔知多少？如今，軟件開發越來越復雜，軟件功能也越來越豐富。而幾乎一切成熟的商業軟件，都是靠一個開發團隊齊心協力的血汗結晶。“羅馬不是一天建成的！，當我們震撼于Microsoft Windows的驚世巨著的同時，也道聽途說了微軟公司軟件工程是如何的完善規范。確實，集數百名員工幾年的共同努力之大成，軟件工程管理的成敗是控制開發本錢的關鍵環節。這里面，少不了貫穿其中的重要步驟-軟件文檔。 軟件文檔可以分為開發文檔和產品文檔兩大類。開發文檔包括：、等。 產品文檔包括：、等。 一、開發文檔 1. -來源于客戶要求和市場調查，是軟件開發中最早期的一個環節。客戶提出一個模糊的功能概念，或者要求

2、處理一個實踐問題，或者參照同類軟件的一個功能。有軟件閱歷的客戶還會提供比較詳細的技術規范書，把他們的要求全部列表書寫在文檔中，必要時加以圖表講解。這份文檔是需求分析的根底。 2. -根據用戶的功能要求，經過與招標方溝通和確認，技術人員開場書寫，方案書普通包括以下幾個重要的章節： 前言-工程背景、公司背景和業務、技術人員構造、公司的勝利案例引見等。 需求分析-工程要求、軟件構造、功能列表、功能描畫、本卷須知等。 技術方案-總體要求和指點思想、技術處理方案、軟件開發平臺、網絡構造體系等。 工程管理-描畫公司的軟件開發流程、工程實施效力、組織和人員分工、開發進度控制、軟件質量保證、工程驗收和人員培訓

3、、軟件資料文檔等。 技術支持-公司的技術支持和效力引見、效力目的和目的、效力級別和呼應時間、技術效力區域、技術效力期限、授權用戶聯絡人等。系統報價-軟、硬件平臺報價列表、軟件開發費用、系統維護費用等。工程進度-整個工程的進度方案，包括簽署合同、工程啟動、需求分析、系統分析、程序開發、測試維護、系統集成、用戶驗收、用戶培訓等步驟的時間規劃。3. -包括產品概述、主要概念、操作流程、功能列表和講解、本卷須知、系統環境等。以為根底，進展詳細的功能分析(包括客戶提出的要求和根據開發閱歷建議的功能)，列出本產品是什么，有什么特殊的概念，包括那些功能分類，需求具備什么功能，該功能的操作如何，實現的時候該留

4、意什么細節，客戶有什么要求，系統運轉環境的要求等。這里的功能描畫跟以后的運用手冊是一致的。4. -包括技術選型、技術比較、開發人員、關鍵技術問題的處理、技術風險、技術晉級方向、技術方案評價，競爭對手技術分析等。以為根底，進展詳細的技術分析(產品的性能和實現方法)，列出本工程需求運用什么技術方案，為什么，有哪些技術問題要處理，估計開發期間會碰到什么困難，技術方案以后如何晉級，對本工程的技術有什么評價等。5. -包括功能實現、模塊組成、功能流程圖、函數接口、數據字典、軟件開發需求思索的各種問題等。以為根底，進展詳細的系統分析(產品的開發和實現方法)，估計開發期間需求把什么問題闡明白，程序員根據，開

5、場在工程主管的帶著下進展編碼。 6. -包括數據庫稱號、表名、字段名、字段類型、字段闡明、備注、字段數值計算公式等。以為根底，進展詳細的數據庫設計。必要時可以用圖表講解，特別是關系數據庫。7. -包括變量名、變量初植、功能，函數名，參數，如何調用、備注、本卷須知等。以為根底，進展詳細的闡明，列出哪個功能涉及多少個函數，以便以后程序員修正、接手和擴展。8. -包括軟件外觀、界面素材、編輯工具、文件名、菜單、按鈕和其它界面部件的要求，這里與軟件完成后的運轉界面是一致的。9. -包括效力器編譯環境、操作系統、編譯工具、GNU的C+編譯器版本信息、目錄闡明、程序生成、源程序文件列表、Makefile配

6、置及其相關程序的對應關系列表。客戶端的編譯過程、編譯結果、編譯例如、編譯環境、操作系統、編譯工具、源文件列表和制造安裝程序的過程。10. -包括產品簡介、產品原理、產品功能列表、功能描畫、功能流程、執行結果、數據庫構造、測試要求等，提供應軟件測試人員運用。11. -包括工程簡介、工程參與人員和開發時間、工程風險管理過程、工程功能列表、工程構造特點、技術特點、對工程的晉級建議、對以后的工程的建議、人員素質情況等。二、產品文檔 1. -包括公司背景、產品概念、適用范圍、產品功能、功能特點、運轉要求和公司。 2. -包括公司簡介、產品背景、產品描畫、產品特點、產品作用、適用范圍、運用分析、功能模塊、

7、處理問題、協作同伴、勝利案例等。普通用Power point或者VCD錄制軟件實現。 3. -列出用戶關懷的問題和處置方法。用于解答軟件的操作功能和處理用戶的疑問問題。 4. -以為書寫根底，包括軟件引見、軟件構造、功能列表、功能描畫和公司。 5. -以為書寫根底，包括功能實現、技術選型、關鍵技術問題的處理、技術方案特點、技術晉級方向等。 6. -第三方權威評測報告。包括評測目的、評測范圍、評測環境、評測內容、實測數據、性能表現、結果分析和評測總結等。 7. -包括系統環境、運轉平臺、產品安裝過程、初始環境設置、安裝記錄等。 8. -包括產品簡介、功能列表、功能描畫和解釋、功能操作、客戶效力和聯絡方式等。 9. -包括產品簡介、系統須知、初始環境設置、系統配置、數據管理和備份、技