綜合管理：軟件文檔知多少

申請免費試用、咨詢電話：400-8352-114

如今，軟件開發(fā)越來越復雜，軟件功能也越來越豐富。而幾乎所有成熟的商業(yè)軟件，都是靠一個開發(fā)團隊齊心協(xié)力的血汗結晶?！傲_馬不是一天建成的！”，當我們震撼于Microsoft Windows的驚世巨著的同時，也道聽途說了微軟公司軟件工程是如何的完善規(guī)范。的確，集數(shù)百名員工幾年的共同努力之大成，軟件項目管理的成敗是控制開發(fā)成本的關鍵環(huán)節(jié)。這里面，少不了貫穿其中的重要步驟----軟件文檔。
　　軟件文檔可以分為開發(fā)文檔和產(chǎn)品文檔兩大類。
　　開發(fā)文檔包括：《功能要求》、《投標方案》、《需求分析》、《技術分析》、《系統(tǒng)分析》、《數(shù)據(jù)庫文檔》、《功能函數(shù)文檔》、《界面文檔》、《編譯手冊》、《QA文檔》、《項目總結》等。
　　產(chǎn)品文檔包括：《產(chǎn)品簡介》、《產(chǎn)品演示》、《疑問解答》、《功能介紹》、 《技術白皮書》、《評測報告》、《安裝手冊》、《使用手冊》、《維護手冊》、 《用戶報告》、《銷售培訓》等。 
　　一、開發(fā)文檔 　　
　　1. 《功能要求》--來源于客戶要求和市場調(diào)查，是軟件開發(fā)中最早期的一個環(huán)節(jié)?？蛻籼岢鲆粋€模糊的功能概念，或者要求解決一個實際問題，或者參照同類軟件的一個功能。有軟件經(jīng)驗的客戶還會提供比較詳細的技術規(guī)范書，把他們的要求全部列表書寫在文檔中，必要時加以圖表解說。這份文檔是需求分析的基礎。
　　2. 《投標方案》--根據(jù)用戶的功能要求，經(jīng)過與招標方溝通和確認，技術人員開始書寫《投標方案》，方案書一般包括以下幾個重要的章節(jié)：
　　前言--項目背景、公司背景和業(yè)務、技術人員結構、公司的成功案例介紹等。
　　需求分析--項目要求、軟件結構、功能列表、功能描述、注意事項等。
　　技術方案--總體要求和指導思想、技術解決方案、軟件開發(fā)平臺、網(wǎng)絡結構體系等。
　　項目管理--描述公司的軟件開發(fā)流程、工程實施服務、組織和人員分工、開發(fā)進度控制、軟件質(zhì)量保證、項目驗收和人員培訓、軟件資料文檔等。
　　技術支持--公司的技術支持和服務介紹、服務宗旨和目標、服務級別和響應時間、技術服務區(qū)域、技術服務期限、授權用戶聯(lián)系人等。
　　系統(tǒng)報價--軟、硬件平臺報價列表、軟件開發(fā)費用、系統(tǒng)維護費用等。
　　項目進度--整個項目的進度計劃，包括簽署合同、項目啟動、需求分析、系統(tǒng)分析、程序開發(fā)、測試維護、系統(tǒng)集成、用戶驗收、用戶培訓等步驟的時間規(guī)劃。
　　3. 《需求分析》--包括產(chǎn)品概述、主要概念、操作流程、功能列表和解說、注意事項、系統(tǒng)環(huán)境等。以《功能要求》為基礎，進行詳細的功能分析(包括客戶提出的要求和根據(jù)開發(fā)經(jīng)驗建議的功能)，列出本產(chǎn)品是什么，有什么特殊的概念，包括那些功能分類，需要具備什么功能，該功能的操作如何，實現(xiàn)的時候該注意什么細節(jié)，客戶有什么要求，系統(tǒng)運行環(huán)境的要求等。這里的功能描述跟以后的使用手冊是一致的。
　　4. 《技術分析》--包括技術選型、技術比較、開發(fā)人員、關鍵技術問題的解決、技術風險、技術升級方向、技術方案評價，競爭對手技術分析等。以《需求分析》為基礎，進行詳細的技術分析(產(chǎn)品的性能和實現(xiàn)方法)，列出本項目需要使用什么技術方案，為什么，有哪些技術問題要解決 ，估計開發(fā)期間會碰到什么困難，技術方案以后如何升級，對本項目的技術有什么評價等。
　　5. 《系統(tǒng)分析》--包括功能實現(xiàn)、模塊組成、功能流程圖、函數(shù)接口、數(shù)據(jù)字典、軟件開發(fā)需要考慮的各種問題等。以《需求分析》為基礎，進行詳細的系統(tǒng)分析(產(chǎn)品的開發(fā)和實現(xiàn)方法)，估計開發(fā)期間需要把什么問題說明白，程序員根據(jù)《系統(tǒng)分析》，開始在項目主管的帶領下進行編碼。
　　6. 《數(shù)據(jù)庫文檔》--包括數(shù)據(jù)庫名稱、表名、字段名、字段類型、字段說明、備注、字段數(shù)值計算公式等。以《系統(tǒng)分析》為基礎，進行詳細的數(shù)據(jù)庫設計。必要時可以用圖表解說，特別是關系數(shù)據(jù)庫。