巴塞罗那vs维戈塞尔塔比分预测
今天是:
0634-6111386
專注于在線教育平臺、辦公信息化、微信小程序、手機客戶端、微信公眾號等系列軟件研發
新聞資訊 News當前位置:首頁 > 新聞資訊 > 行業新聞

你知道軟件開發文檔怎么寫嗎?

作者:思科商務 來源:本站 發表時間:2015/12/22 15:01:02 查看:
如今,軟件開發越來越復雜,軟件的功能也越來越豐富。而幾乎所有成熟的商業軟件,都是一個開發團隊齊心協力的血汗結晶。“羅馬不是一天建成的。”,當我們震撼于Microsoft Windows的驚世巨著的同時,也道聽途說了一些微軟公司軟件工程是如何的完善和規范。軟件項目管理的成敗是控制開發成本的關鍵環節。這里面,少不了貫穿其中的重要步驟——軟件文檔。
軟件文檔可以分為開發文檔和產品文檔兩大類:
開發文檔包括:《功能要求》、《投標方案》、《需求分析》、《技術分析》、《系統分析》、《數據庫文檔》、《功能函數文檔》、《界面文檔》、《編譯手冊》、《QA文檔》、《項目總結》等。
產品文檔包括:《產品簡介》、《產品技術白皮書》、《評測報告》、《安裝手冊》、《使用手冊》、《維護手冊》、 《用戶報告》、《銷售培訓》等。
一、開發文檔
1. 《功能要求》——來源于客戶要求和市場調查,是軟件開發中最早期的一個環節。客戶提出一個模糊的功能概念,或者要求解決一個實際問題,又或者是參照同類軟件的一個功能。有軟件經驗的客戶還會提供比較詳細的技術規范書,把他們的要求全部列表書寫在文檔中,必要時加以圖表解說。這份文檔是需求分析的基礎。
2. 《投標方案》——根據用戶的功能要求,經過與招標方溝通和確認,技術人員開始書寫《投標方案》,方案書一般包括前言、需求分析、技術方案、項目管理、技術支持、系統報價、項目進度等。
3. 《需求分析》——包括產品概述、主要概念、操作流程、功能列表、注意事項、系統環境等。以《功能要求》為基礎,進行詳細的功能分析,列出本產品是什么,有什么特殊的概念,包括那些功能分類,需要具備什么功能,該功能的操作如何,實現的時候該注意什么細 節,客戶有什么要求,系統運行環境的要求等。這里的功能描述跟以后的使用手冊是一致的。
4. 《技術分析》——包括技術選型、技術比較、開發人員、關鍵技術問題的解決、技術風險、技術升級方向、技術方案評價,競爭對手技術分析等。以《需求分析》為基礎,進行詳細的技術分析(產品的性能和實現方法),列出本項目需要使用什么技術方案,為什么,有哪些技術問題要解決 ,估計開發期間會碰到什么困難,技術方案以后如何升級,對本項目的技術有什么評價等。
5. 《系統分析》——包括功能實現、模塊組成、功能流程圖、函數接口、數據字典、軟件開發需要考慮的各種問題等。以《需求分析》為基礎,進行詳細的系統分析(產品的開發和實現方法),程序員根據《系統分析》,開始在項目主管的帶領下進行編碼工作。
6. 《數據庫文檔》——包括數據庫名稱、表名、字段名、字段類型、字段說明、備注、字段數值計算公式等。以《系統分析》為基礎,進行詳細的數據庫設計,必要時可以用圖表解說,特別是關系數據庫。
7. 《功能函數文檔》——包括變量名、變量初植、功能、函數名、參數、如何調用、備注、注意事項等。以《系統分析》為基礎,進行詳細的說明,列出哪個功能涉及多少個函數,以便以后程序員修改、接手和擴展。
8. 《界面文檔》——包括軟件外觀、界面素材、編輯工具、文件名、菜單、按鈕和其它界面部件的要求,這里與軟件完成后的運行界面是一致的。
9. 《編譯手冊》——包括服務器編譯環境、操作系統、編譯工具、編譯器版本信息、目錄說明、程序生成、源程序文件列表、Makefile配置及其相關程序的對應關系列表。客戶端的編譯過程、編譯結果、編譯示例、編譯環境、操作系統、編譯工具、源文件列表和制作安裝程序的過程。
10. 《QA文檔》——包括產品簡介、產品原理、產品功能列表、功能描述、功能流程、執行結果、數據庫結構、測試要求等,提供給軟件測試人員使用。
11. 《項目總結》——包括項目簡介、項目參與人員和開發時間、項目風險、管理過程、項目功能列表、項目結構特點、技術特點、對項目的升級建議、對以后的項目的建議、人員工作情況等。
二、產品文檔
1. 《產品簡介》——包括公司背景、產品概念、適用范圍、產品功能、功能特點、運行要求和公司聯系地址等。
2. 《產品演示》——包括公司簡介、產品背景、產品描述、產品特點、產品作用、適用范圍、使用分析、功能模塊、解決問題、合作伙伴、成功案例等。一般用Powerpoint或者視頻錄制軟件實現。
3. 《疑問解答》——列出用戶關心的問題和處理方法,用于解答軟件的操作功能和解決用戶的疑難問題。
4. 《功能介紹》——以《需求分析》為書寫基礎,包括軟件介紹、軟件結構、功能列表、功能描述等。
5. 《技術白皮書》——以《技術分析》為書寫基礎,包括功能實現、技術選型、關鍵技術問題的解決、技術方案特點、技術升級方向等。
6. 《評測報告》——第三方的權威評測報告。包括評測目的、評測范圍、評測環境、評測內容、實測數據、性能表現、結果分析和評測總結等。
7. 《安裝手冊》——包括系統環境、運行平臺、產品安裝過程、初始環境設置、安裝記錄等。
8. 《使用手冊》——包括產品簡介、功能列表、功能描述和解釋、功能操作、客戶服務和聯系方式等。
9. 《維護手冊》——包括產品簡介、系統須知、初始環境設置、系統配置、數據管理和備份、技術問題解答和聯系方式等。
10. 《用戶報告》——包括產品簡介、購買時間、使用目的、使用時間、使用地點、實施過程、出現問題和解決、產品總結和建議等。
11.《銷售培訓》——包括項目簡介、產品功能、產品特點、商業優勢、系統運行環境、適用范圍、目標客戶等。
新聞分類 News Nav
聯系我們 Contact Us

全國統一服務熱線

0634-6111386

我們的郵箱

[email protected]

在線客服

萊蕪軟件開發|萊蕪網站建設|萊蕪網絡公司|萊蕪微信開發|萊蕪思科電子商務有限公司
0
巴塞罗那vs维戈塞尔塔比分预测 盛兴秒速时时开奖 安徽时时结果 pk10六码公式计划 北京k10赛车彩控开奖 gpk电子以分技术 36选7为什么有8个号码 广东十一选五手机版本 平安彩票网注册平台 im体育平台 时时走势图网易 彩票双色球历史开奖结果 江苏时时开奖视频