軟件開(kāi)發(fā)文檔基本知識 軟件文檔可以分為開(kāi)發(fā)文檔和產(chǎn)品文檔兩大類(lèi)。 開(kāi)發(fā)文檔包括：《功能要求》、《投標方案》、《需求分析》、《技術(shù)分析》、《系統分析》、《數據庫文檔》、《功能函數文檔》、《界面文檔》、《編譯手冊》、《 QA 文檔》、《項目總結》等。 產(chǎn)品文檔包括：《產(chǎn)品簡(jiǎn)介》、《產(chǎn)品演示》、《疑問(wèn)解答》、《功能介紹》、 《技術(shù)白皮書(shū)》、《評測報告》、《安裝手冊》、《使用手冊》、《維護手冊》、 《用戶(hù)報告》、《銷(xiāo)售培訓》等。 一、開(kāi)發(fā)文檔 1. 《功能要求》 -- 來(lái)源于客戶(hù)要求和市場(chǎng)調查，是軟件開(kāi)發(fā)中最早期的一個(gè)環(huán)節?？蛻?hù)提出一個(gè)模糊的功能概念，或者要求解決一個(gè)實(shí)際問(wèn)題，或者參照同類(lèi)軟件的一個(gè)功能。有軟件經(jīng)驗的客戶(hù)還會(huì )提供比較詳細的技術(shù)規范書(shū)，把他們的要求全部列表書(shū)寫(xiě)在文檔中，必要時(shí)加以圖表解說(shuō)。這份文檔是需求分析的基礎。 2. 《投標方案》 -- 根據用戶(hù)的功能要求，經(jīng)過(guò)與招標方溝通和確認，技術(shù)人員開(kāi)始書(shū)寫(xiě)《投標方案》，方案書(shū)一般包括以下幾個(gè)重要的章節： 前言 -- 項目背景、公司背景和業(yè)務(wù)、技術(shù)人員結構、公司的成功案例介紹等。 需求分析 -- 項目要求、軟件結構、功能列表、功能描述、注意事項等。 技術(shù)方案 -- 總體要求和指導思想、技術(shù)解決方案、軟件開(kāi)發(fā)平臺、網(wǎng)絡(luò )結構體系等。 項目管理 -- 描述公司的軟件開(kāi)發(fā)流程、工程實(shí)施服務(wù)、組織和人員分工、開(kāi)發(fā)進(jìn)度控制、軟件質(zhì)量保證、項目驗收和人員培訓、軟件資料文檔等。 技術(shù)支持 -- 公司的技術(shù)支持和服務(wù)介紹、服務(wù)宗旨和目標、服務(wù)級別和響應時(shí)間、技術(shù)服務(wù)區域、技術(shù)服務(wù)期限、授權用戶(hù)聯(lián)系人等。 系統報價(jià) -- 軟、硬件平臺報價(jià)列表、軟件開(kāi)發(fā)費用、系統維護費用等。 項目進(jìn)度 -- 整個(gè)項目的進(jìn)度計劃，包括簽署合同、項目啟動(dòng)、需求分析、系統分析、程序開(kāi)發(fā)、測試維護、系統集成、用戶(hù)驗收、用戶(hù)培訓等步驟的時(shí)間規劃。 3. 《需求分析》 -- 包括產(chǎn)品概述、主要概念、操作流程、功能列表和解說(shuō)、注意事項、系統環(huán)境等。以《功能要求》為基礎，進(jìn)行詳細的功能分析 ( 包括客戶(hù)提出的要求和根據開(kāi)發(fā)經(jīng)驗建議的功能 ) ，列出本產(chǎn)品是什么，有什么特殊的概念，包括那些功能分類(lèi)，需要具備什么功能，該功能的操作如何，實(shí)現的時(shí)候該注意什么細節，客戶(hù)有什么要求，系統運行環(huán)境的要求等。這里的功能描述跟以后的使用手冊是一致的。 4. 《技術(shù)分析》 -- 包括技術(shù)選型、技術(shù)比較、開(kāi)發(fā)人員、關(guān)鍵技術(shù)問(wèn)題的解決、技術(shù)風(fēng)險、技術(shù)升級方向、技術(shù)方案評價(jià)，競爭對手技術(shù)分析等。以《需求分析》為基礎，進(jìn)行詳細的技術(shù)分析 ( 產(chǎn)品的性能和實(shí)現方法 ) ，列出本項目需要使用什么技術(shù)方案，為什么，有哪些技術(shù)問(wèn)題要解決 ，估計開(kāi)發(fā)期間會(huì )碰到什么困難，技術(shù)方案以后如何升級，對本項目的技術(shù)有什么評價(jià)等。 5. 《系統分析》 -- 包括功能實(shí)現、模塊組成、功能流程圖、函數接口、數據字典、軟件開(kāi)發(fā)需要考慮的各種問(wèn)題等。以《需求分析》為基礎，進(jìn)行詳細的系統分析 ( 產(chǎn)品的開(kāi)發(fā)和實(shí)現方法 ) ，估計開(kāi)發(fā)期間需要把什么問(wèn)題說(shuō)明白，程序員根據《系統分析》，開(kāi)始在項目主管的帶領(lǐng)下進(jìn)行編碼。 6. 《數據庫文檔》 -- 包括數據庫名稱(chēng)、表名、字段名、字段類(lèi)型、字段說(shuō)明、備注、字段數值計算公式等。以《系統分析》為基礎，進(jìn)行詳細的數據庫設計。必要時(shí)可以用圖表解說(shuō)，特別是關(guān)系數據庫。 7. 《功能函數文檔》 -- 包括變量名、變量初植、功能，函數名，參數，如何調用、備注、注意事項等。以《系統分析》為基礎，進(jìn)行詳細的說(shuō)明，列出哪個(gè)功能涉及多少個(gè)函數，以便以后程序員修改、接手和擴展。 8. 《界面文檔》 -- 包括軟件外觀(guān)、界面素材、編輯工具、文件名、菜單、按鈕和其它界面部件的要求，這里與軟件完成后的運行界面是一致的。 9. 《編譯手冊》 -- 包括服務(wù)器編譯環(huán)境、操作系統、編譯工具、 GNU 的 C++ 編譯器版本信息、目錄說(shuō)明、程序生成、源程序文件列表、 Makefile 配置及其相關(guān)程序的對應關(guān)系列表?？蛻?hù)端的編譯過(guò)程、編譯結果、編譯示例、編譯環(huán)境、操作系統、編譯工具、源文件列表和制作安裝程序的過(guò)程。 10. 《 QA 文檔》 -- 包括產(chǎn)品簡(jiǎn)介、產(chǎn)品原理、產(chǎn)品功能列表、功能描述、功能流程、執行結果、數據庫結構、測試要求等，提供給軟件測試人員使用。 11. 《項目總結》 -- 包括項目簡(jiǎn)介、項目參與人員和開(kāi)發(fā)時(shí)間、項目風(fēng)險管理過(guò)程、項目功能列表、項目結構特點(diǎn)、技術(shù)特點(diǎn)、對項目的升級建議、對以后的項目的建議、人員素質(zhì)情況等。 二、產(chǎn)品文檔 1. 《產(chǎn)品簡(jiǎn)介》 -- 包括公司背景、產(chǎn)品概念、適用范圍、產(chǎn)品功能、功能特點(diǎn)、運行要求和公司聯(lián)系地址。 2. 《產(chǎn)品演示》 -- 包括公司簡(jiǎn)介、產(chǎn)品背景、產(chǎn)品描述、產(chǎn)品特點(diǎn)、產(chǎn)品作用、適用范圍、使用分析、功能模塊、解決問(wèn)題、合作伙伴、成功案例等。一般用 Power point 或者 VCD 錄制軟件實(shí)現。 3. 《疑問(wèn)解答》 -- 列出用戶(hù)關(guān)心的問(wèn)題和處理方法。用于解答軟件的操作功能和解決用戶(hù)的疑難問(wèn)題。 4. 《功能介紹》 -- 以《需求分析》為書(shū)寫(xiě)基礎，包括軟件介紹、軟件結構、功能列表、功能描述和公司聯(lián)系地址。 5. 《技術(shù)白皮書(shū)》 -- 以《技術(shù)分析》為書(shū)寫(xiě)基礎，包括功能實(shí)現、技術(shù)選型、關(guān)鍵技術(shù)問(wèn)題的解決、技術(shù)方案特點(diǎn)、技術(shù)升級方向等。 6. 《評測報告》 -- 第三方權威評測報告。包括評測目的、評測范圍、評測環(huán)境、評測內容、實(shí)測數據、性能表現、結果分析和評測總結等。 7. 《安裝手冊》 -- 包括系統環(huán)境、運行平臺、產(chǎn)品安裝過(guò)程、初始環(huán)境設置、安裝記錄等。 8. 《使用手冊》 -- 包括產(chǎn)品簡(jiǎn)介、功能列表、功能描述和解釋、功能操作、客戶(hù)服務(wù)和聯(lián)系方式等。 9. 《維護手冊》 -- 包括產(chǎn)品簡(jiǎn)介、系統須知、初始環(huán)境設置、系統配置、數據管理和備份、技術(shù)問(wèn)題解答和聯(lián)系方式等。 10. 《用戶(hù)報告》 -- 包括產(chǎn)品簡(jiǎn)介、購買(mǎi)時(shí)間、使用目的、使用時(shí)間、使用地點(diǎn)、實(shí)施過(guò)程、出現問(wèn)題和解決、產(chǎn)品總結和建議等。 11. 《銷(xiāo)售培訓》 -- 包括項目簡(jiǎn)介、產(chǎn)品功能、產(chǎn)品特點(diǎn)、商業(yè)優(yōu)勢、系統運行環(huán)境、適用范圍、目標客戶(hù)等。 |
聯(lián)系客服
