it項目管理人員必備的軟件文檔知識.doc

1、軟件文檔知多少？如今，軟件開發(fā)越來越復(fù)雜，軟件功能也越來越豐富。而幾乎所有成熟的商業(yè)軟件，都是靠一個開發(fā)團隊齊心協(xié)力 的血汗結(jié)晶。 “羅馬不是一天建成的！ ”，當我們震撼于Microsoft Windows 的驚世巨著的同時， 也道聽途說了微軟公 司軟件工程是如何的完善規(guī)范。的確，集數(shù)百名員工幾年的 共同努力之大成，軟件項目管理的成敗是控制開發(fā)成本的關(guān)鍵環(huán)節(jié)。這里面，少不了貫穿其中的重要步驟 軟件文檔。軟件文檔可以分為開發(fā)文檔和產(chǎn)品文檔兩大類。開發(fā)文檔包括： 功能要求 、投標方案 、需求分析 、技術(shù)分析 、系統(tǒng)分析 、數(shù)據(jù)庫文檔 、功能函數(shù)文檔 、界面文檔、編譯手冊、QA文檔、項目總結(jié)等。產(chǎn)品

2、文檔包括：產(chǎn)品簡介 、產(chǎn)品演示 、疑問解答 、功能介紹 、技術(shù)白皮書 、評測報告 、安裝手冊 、使 用手冊、維護手冊 、用戶報告 、銷售培訓(xùn)等。、開發(fā)文檔1. 功能要求 - 來源于客戶要求和市場調(diào)查，是軟件開發(fā)中最早期的一個環(huán)節(jié)。客戶提出一個模糊的功能概念，或者要求解決一個實際問題，或者參照同類軟件的一個功能。有軟件經(jīng)驗的客戶還會提供比較詳細的技術(shù)規(guī)范書，把他們的要求全部列表書寫在文檔中，必要時加以圖表解說。2.這份文檔是需求分析的基礎(chǔ)。投標方案 - 根據(jù)用戶的功能要求，經(jīng)過與招標方 包括以下幾個重要的章節(jié)：溝通和確認，技術(shù)人員開始書寫投標方案，方案書一般前言 -項目背景、公司背景和業(yè)務(wù)、技術(shù)

3、人員結(jié)構(gòu)、公司的成功案例介紹等。需求分析 - 項目要求、軟件結(jié)構(gòu)、功能列表、功能描述、注意事項等。技術(shù)方案 - 總體要求和指導(dǎo)思想、技術(shù)解決方案、軟件開發(fā)平臺、網(wǎng)絡(luò)結(jié)構(gòu)體系等。項目管理 -描述公司的軟件開發(fā)流程、工程實施服務(wù)、組織和人員分工、開發(fā)進度控制、軟件質(zhì)量保證、項目驗收 和人員培訓(xùn)、軟件資料文檔等。技術(shù)支持 -公司的技術(shù)支持和服務(wù)介紹、服務(wù)宗旨和目標、服務(wù)級別和響應(yīng)時間、技術(shù)服務(wù)區(qū)域、技術(shù)服務(wù)期限、 授權(quán)用戶聯(lián)系人等。系統(tǒng)報價 -軟、硬件平臺報價列表、軟件開發(fā)費用、系統(tǒng)維護費用等。項目進度 -整個項目的進度計劃，包括簽署合同、項目啟動、需求分析、系統(tǒng)分析、程序開發(fā)、測試維護、系統(tǒng)集 成

4、、用戶驗收、用戶培訓(xùn)等步驟的時間規(guī)劃。3. 需求分析 -包括產(chǎn)品概述、主要概念、操作流程、功能列表和解說、注意事項、系統(tǒng)環(huán)境等。以功能要求 為基礎(chǔ)， 進行詳細的功能分析 （包括客戶提出的要求和根據(jù)開發(fā)經(jīng)驗建議的功能 ），列出本產(chǎn)品是什么， 有什么特殊的概念， 實現(xiàn)的時候該注意什么細節(jié)，客戶有什么要求，系統(tǒng)運行環(huán) 境的要求等。這里的功能描述跟以后的使用手冊是一致的。包括那些功能分類，需要具備什么功能， 該功能的操作如何，4. 技術(shù)分析 -包括技術(shù)選型、技術(shù)比較、開發(fā)人員、關(guān)鍵技術(shù)問題的解決、技術(shù)風(fēng)險、技術(shù)升級方向、技術(shù)方案 評價，競爭對手技術(shù)分析等。以需求分析為基礎(chǔ)，進行 詳細的技術(shù)分析 （產(chǎn)品

5、的性能和實現(xiàn)方法 ），列出本項目需要使用什么技術(shù)方案，為什么，有哪些技術(shù)問題要解決，估計 開發(fā)期間會碰到什么困難，技術(shù)方案以后如何升級，對本項 目的技術(shù)有什么評價等。5. 系統(tǒng)分析 - 包括功能實現(xiàn)、模塊組成、功能流程圖、函數(shù)接口、 數(shù)據(jù)字典、 軟件開發(fā)需要考慮的各種問題等。以需求分析為基礎(chǔ)，進行詳細的系統(tǒng)分析 （產(chǎn)品的開發(fā)和實現(xiàn)方法 ），估計開發(fā)期間需要把什么問題說明白，程序員根 據(jù)系統(tǒng)分析 ，開始在項目主管的帶領(lǐng)下進行編碼。6. 數(shù)據(jù)庫文檔 -包括數(shù)據(jù)庫名稱、表名、字段名、字段類型、字段說明、備注、字段數(shù)值計算公式等。以系 統(tǒng)分析為基礎(chǔ)，進行詳細的數(shù)據(jù)庫設(shè)計。必要時可以用圖表解說，特別是關(guān)

6、系數(shù)據(jù)庫。7.功能函數(shù)文檔 -包括變量名、變量初植、功能，函數(shù)名，參數(shù)，如何調(diào)用、備注、注意事項等。以系統(tǒng)分 析為基礎(chǔ)，進行詳細的說明，列出哪個功能涉及多少個函 數(shù)，以便以后程序員修改、接手和擴展。8. 界面文檔 - 包括軟件外觀、界面素材、編輯工具、文件名、菜單、按鈕和其它界面部件的要求，這里與軟件完 成后的運行界面是一致的。9. 編譯手冊 - 包括服務(wù)器編譯環(huán)境、操作系統(tǒng)、編譯工具、GNU的C+編譯器版本信息、目錄說明、程序生成、 源程序文件列表、 Makefile 配置及其相關(guān)程序的對應(yīng)關(guān)系列 表?？蛻舳说木幾g過程、編譯結(jié)果、編譯示例、編譯環(huán)境、 操作系統(tǒng)、編譯工具、源文件列表和制作安裝

7、程序的過程。10. QA 文檔 -包括產(chǎn)品簡介、產(chǎn)品原理、產(chǎn)品功能列表、功能描述、功能流程、執(zhí)行結(jié)果、數(shù)據(jù)庫結(jié)構(gòu)、測試 要求等，提供給軟件測試人員使用。11. 項目總結(jié) -包括項目簡介、 項目參與人員和開發(fā)時間、項目風(fēng)險管理過程、項目功能列表、項目結(jié)構(gòu)特點、 技術(shù)特點、對項目的升級建議、對以后的項目的建議、人員 素質(zhì)情況等。二、產(chǎn)品文檔1. 產(chǎn)品簡介 -包括公司背景、產(chǎn)品概念、適用范圍、產(chǎn)品功能、功能特點、運行要求和公司聯(lián)系地址。2. 產(chǎn)品演示 -包括公司簡介、產(chǎn)品背景、產(chǎn)品描述、產(chǎn)品特點、產(chǎn)品作用、適用范圍、使用分析、功能模塊、解決問題、合作伙伴、成功案例等。一般用Powerpoint 或者

8、 VCD 錄制軟件實現(xiàn)。3. 疑問解答 - 列出用戶關(guān)心的問題和處理方法。用于解答軟件的操作功能和解決用戶的疑難問題。4. 功能介紹 - 以需求分析為書寫基礎(chǔ)，包括軟件介紹、軟件結(jié)構(gòu)、功能列表、功能描述和公司聯(lián)系地址。5. 技術(shù)白皮書 -以技術(shù)分析為書寫基礎(chǔ)，包括功能實現(xiàn)、 技術(shù)選型、 關(guān)鍵技術(shù)問題的解決、 技術(shù)方案特點、技術(shù)升級方向等。6. 評測報告- 第三方權(quán)威評測報告。 包括評測目的、評測范圍、評測環(huán)境、評測內(nèi)容、實測數(shù)據(jù)、性能表現(xiàn)、結(jié)果分析和評測總結(jié)等。7. 安裝手冊-包括系統(tǒng)環(huán)境、運行平臺、產(chǎn)品安裝過程、初始環(huán)境設(shè)置、安裝記錄等。8. 使用手冊-包括產(chǎn)品簡介、功能列表、功能描述和解釋、功能操作、客戶服務(wù)和聯(lián)系方式等。9. 維護手冊 - 包括產(chǎn)品簡介、系統(tǒng)須知、初始環(huán)境設(shè)置、系統(tǒng)配置、數(shù)據(jù)