IT項(xiàng)目管理人員必備的軟件文檔知識

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

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

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

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

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

6、置及其相關(guān)程序的對應(yīng)關(guān)系列表?？蛻舳说木幾g過程、編譯結(jié)果、編譯例如、編譯環(huán)境、操作系統(tǒng)、編譯工具、源文件列表和制造安裝程序的過程。10. -包括產(chǎn)品簡介、產(chǎn)品原理、產(chǎn)品功能列表、功能描畫、功能流程、執(zhí)行結(jié)果、數(shù)據(jù)庫構(gòu)造、測試要求等，提供應(yīng)軟件測試人員運(yùn)用。11. -包括工程簡介、工程參與人員和開發(fā)時間、工程風(fēng)險(xiǎn)管理過程、工程功能列表、工程構(gòu)造特點(diǎn)、技術(shù)特點(diǎn)、對工程的晉級建議、對以后的工程的建議、人員素質(zhì)情況等。二、產(chǎn)品文檔 1. -包括公司背景、產(chǎn)品概念、適用范圍、產(chǎn)品功能、功能特點(diǎn)、運(yùn)轉(zhuǎn)要求和公司。 2. -包括公司簡介、產(chǎn)品背景、產(chǎn)品描畫、產(chǎn)品特點(diǎn)、產(chǎn)品作用、適用范圍、運(yùn)用分析、功能模塊、

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