如今，軟件開發(fā)越來越復(fù)雜，軟件的功能也越來越豐富。而幾乎所有成熟的商業(yè)軟件，都是一個(gè)開發(fā)團(tuán)隊(duì)齊心協(xié)力的血汗結(jié)晶?！傲_馬不是一天建成的?！?，當(dāng)我們震撼于Microsoft Windows的驚世巨著的同時(shí)，也道聽途說了一些微軟公司軟件工程是如何的完善和規(guī)范。軟件項(xiàng)目管理的成敗是控制開發(fā)成本的關(guān)鍵環(huán)節(jié)。這里面，少不了貫穿其中的重要步驟——軟件文檔。  

軟件文檔可以分為開發(fā)文檔和產(chǎn)品文檔兩大類： 

開發(fā)文檔包括：《功能要求》、《投標(biāo)方案》、《需求分析》、《技術(shù)分析》、《系統(tǒng)分析》、《數(shù)據(jù)庫文檔》、《功能函數(shù)文檔》、《界面文檔》、《編譯手冊》、《QA文檔》、《項(xiàng)目總結(jié)》等。 

產(chǎn)品文檔包括：《產(chǎn)品簡介》、《產(chǎn)品技術(shù)白皮書》、《評測報(bào)告》、《安裝手冊》、《使用手冊》、《維護(hù)手冊》、《用戶報(bào)告》、《銷售培訓(xùn)》等。 

一、開發(fā)文檔 

1. 《功能要求》——來源于客戶要求和市場調(diào)查，是軟件開發(fā)中最早期的一個(gè)環(huán)節(jié)?？蛻籼岢鲆粋€(gè)模糊的功能概念，或者要求解決一個(gè)實(shí)際問題，又或者是參照同類軟件的一個(gè)功能。有軟件經(jīng)驗(yàn)的客戶還會(huì)提供比較詳細(xì)的技術(shù)規(guī)范書，把他們的要求全部列表書寫在文檔中，必要時(shí)加以圖表解說。這份文檔是需求分析的基礎(chǔ)。 

2. 《投標(biāo)方案》——根據(jù)用戶的功能要求，經(jīng)過與招標(biāo)方溝通和確認(rèn)，技術(shù)人員開始書寫《投標(biāo)方案》，方案書一般包括前言、需求分析、技術(shù)方案、項(xiàng)目管理、技術(shù)支持、系統(tǒng)報(bào)價(jià)、項(xiàng)目進(jìn)度等。 

3. 《需 求分析》——包括產(chǎn)品概述、主要概念、操作流程、功能列表、注意事項(xiàng)、系統(tǒng)環(huán)境等。以《功能要求》為基礎(chǔ)，進(jìn)行詳細(xì)的功能分析，列出本產(chǎn)品是什么，有什么 特殊的概念，包括那些功能分類，需要具備什么功能，該功能的操作如何，實(shí)現(xiàn)的時(shí)候該注意什么細(xì) 節(jié)，客戶有什么要求，系統(tǒng)運(yùn)行環(huán)境的要求等。這里的功能描 述跟以后的使用手冊是一致的。 

4. 《技 術(shù)分析》——包括技術(shù)選型、技術(shù)比較、開發(fā)人員、關(guān)鍵技術(shù)問題的解決、技術(shù)風(fēng)險(xiǎn)、技術(shù)升級方向、技術(shù)方案評價(jià)，競爭對手技術(shù)分析等。以《需求分析》為基 礎(chǔ)，進(jìn)行詳細(xì)的技術(shù)分析（產(chǎn)品的性能和實(shí)現(xiàn)方法），列出本項(xiàng)目需要使用什么技術(shù)方案，為什么，有哪些技術(shù)問題要解決 ，估計(jì)開發(fā)期間會(huì)碰到什么困難，技術(shù) 方案以后如何升級，對本項(xiàng)目的技術(shù)有什么評價(jià)等。 

5. 《系統(tǒng)分析》——包括功能實(shí)現(xiàn)、模塊組成、功能流程圖、函數(shù)接口、數(shù)據(jù)字典、軟件開發(fā)需要考慮的各種問題等。以《需求分析》為基礎(chǔ)，進(jìn)行詳細(xì)的系統(tǒng)分析（產(chǎn)品的開發(fā)和實(shí)現(xiàn)方法），程序員根據(jù)《系統(tǒng)分析》，開始在項(xiàng)目主管的帶領(lǐng)下進(jìn)行編碼工作。 

6. 《數(shù)據(jù)庫文檔》——包括數(shù)據(jù)庫名稱、表名、字段名、字段類型、字段說明、備注、字段數(shù)值計(jì)算公式等。以《系統(tǒng)分析》為基礎(chǔ)，進(jìn)行詳細(xì)的數(shù)據(jù)庫設(shè)計(jì)，必要時(shí)可以用圖表解說，特別是關(guān)系數(shù)據(jù)庫。 

7. 《功能函數(shù)文檔》——包括變量名、變量初植、功能、函數(shù)名、參數(shù)、如何調(diào)用、備注、注意事項(xiàng)等。以《系統(tǒng)分析》為基礎(chǔ)，進(jìn)行詳細(xì)的說明，列出哪個(gè)功能涉及多少個(gè)函數(shù)，以便以后程序員修改、接手和擴(kuò)展。 

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

9. 《編譯手冊》——包括服務(wù)器編譯環(huán)境、操作系統(tǒng)、編譯工具、編譯器版本信息、目錄說明、程序生成、源程序文件列表、Makefile配置及其相關(guān)程序的對應(yīng)關(guān)系列表?？蛻舳说木幾g過程、編譯結(jié)果、編譯示例、編譯環(huán)境、操作系統(tǒng)、編譯工具、源文件列表和制作安裝程序的過程。 

10. 《QA文檔》——包括產(chǎn)品簡介、產(chǎn)品原理、產(chǎn)品功能列表、功能描述、功能流程、執(zhí)行結(jié)果、數(shù)據(jù)庫結(jié)構(gòu)、測試要求等，提供給軟件測試人員使用。 

11. 《項(xiàng)目總結(jié)》——包括項(xiàng)目簡介、項(xiàng)目參與人員和開發(fā)時(shí)間、項(xiàng)目風(fēng)險(xiǎn)、管理過程、項(xiàng)目功能列表、項(xiàng)目結(jié)構(gòu)特點(diǎn)、技術(shù)特點(diǎn)、對項(xiàng)目的升級建議、對以后的項(xiàng)目的建議、人員工作情況等。  

二、產(chǎn)品文檔 

1. 《產(chǎn)品簡介》——包括公司背景、產(chǎn)品概念、適用范圍、產(chǎn)品功能、功能特點(diǎn)、運(yùn)行要求和公司聯(lián)系地址等。 

2. 《產(chǎn)品演示》——包括公司簡介、產(chǎn)品背景、產(chǎn)品描述、產(chǎn)品特點(diǎn)、產(chǎn)品作用、適用范圍、使用分析、功能模塊、解決問題、合作伙伴、成功案例等。一般用Powerpoint或者視頻錄制軟件實(shí)現(xiàn)。 

3. 《疑問解答》——列出用戶關(guān)心的問題和處理方法，用于解答軟件的操作功能和解決用戶的疑難問題。 

4. 《功能介紹》——以《需求分析》為書寫基礎(chǔ)，包括軟件介紹、軟件結(jié)構(gòu)、功能列表、功能描述等。 

5. 《技術(shù)白皮書》——以《技術(shù)分析》為書寫基礎(chǔ)，包括功能實(shí)現(xiàn)、技術(shù)選型、關(guān)鍵技術(shù)問題的解決、技術(shù)方案特點(diǎn)、技術(shù)升級方向等。 

6. 《評測報(bào)告》——第三方的權(quán)威評測報(bào)告。包括評測目的、評測范圍、評測環(huán)境、評測內(nèi)容、實(shí)測數(shù)據(jù)、性能表現(xiàn)、結(jié)果分析和評測總結(jié)等。 

7. 《安裝手冊》——包括系統(tǒng)環(huán)境、運(yùn)行平臺、產(chǎn)品安裝過程、初始環(huán)境設(shè)置、安裝記錄等。 

8. 《使用手冊》——包括產(chǎn)品簡介、功能列表、功能描述和解釋、功能操作、客戶服務(wù)和聯(lián)系方式等。 

9. 《維護(hù)手冊》——包括產(chǎn)品簡介、系統(tǒng)須知、初始環(huán)境設(shè)置、系統(tǒng)配置、數(shù)據(jù)管理和備份、技術(shù)問題解答和聯(lián)系方式等。 

10. 《用戶報(bào)告》——包括產(chǎn)品簡介、購買時(shí)間、使用目的、使用時(shí)間、使用地點(diǎn)、實(shí)施過程、出現(xiàn)問題和解決、產(chǎn)品總結(jié)和建議等。 

11.《銷售培訓(xùn)》——包括項(xiàng)目簡介、產(chǎn)品功能、產(chǎn)品特點(diǎn)、商業(yè)優(yōu)勢、系統(tǒng)運(yùn)行環(huán)境、適用范圍、目標(biāo)客戶等。