你會寫軟體開發文件嗎?

2021-07-02 05:37:46 字數 1870 閱讀 1287

分享到:26

如今,軟體開發越來越複雜,軟體的功能也越來越豐富。而幾乎所有成熟的商業軟體,都是乙個開發團隊齊心協力的血汗結晶。軟體專案管理的成敗是控制開發成本的關鍵環節。這裡面,少不了貫穿其中的重要步驟——軟體文件。

如今,軟體開發越來越複雜,軟體的功能也越來越豐富。而幾乎所有成熟的商業軟體,都是乙個開發團隊齊心協力的血汗結晶。「羅馬不是一天建成的。」,當我們震撼於microsoft windows的驚世巨著的同時,也道聽途說了一些微軟公司軟體工程是如何的完善和規範。軟體專案管理的成敗是控制開發成本的關鍵環節。這裡面,少不了貫穿其中的重要步驟——軟體文件。 

軟體文件可以分為開發文件和產品文件兩大類:

開發文件包括:《功能要求》、《投標方案》、《需求分析》、《技術分析》、《系統分析》、《資料庫文件》、《功能函式文件》、《介面文件》、《編譯手冊》、《qa文件》、《專案總結》等。

產品文件包括:《產品簡介》、《產品技術***》、《評測報告》、《安裝手冊》、《使用手冊》、《維護手冊》、 《使用者報告》、《銷售培訓》等。

1. 《功能要求》——**於客戶要求和市場調查,是軟體開發中最早期的乙個環節。客戶提出乙個模糊的功能概念,或者要求解決乙個實際問題,又或者是參照同類軟體的乙個功能。有軟體經驗的客戶還會提供比較詳細的技術規範書,把他們的要求全部列表書寫在文件中,必要時加以圖表解說。這份文件是需求分析的基礎。

2. 《投標方案》——根據使用者的功能要求,經過與招標方溝通和確認,技術人員開始書寫《投標方案》,方案書一般包括前言、需求分析、技術方案、專案管理、技術支援、系統**、專案進度等。

3. 《需求分析》——包括產品概述、主要概念、操作流程、功能列表、注意事項、系統環境等。以《功能要求》為基礎,進行詳細的功能分析,列出本產品是什麼,有什麼特殊的概念,包括那些功能分類,需要具備什麼功能,該功能的操作如何,實現的時候該注意什麼細 節,客戶有什麼要求,系統執行環境的要求等。這裡的功能描述跟以後的使用手冊是一致的。

4. 《技術分析》——包括技術選型、技術比較、開發人員、關鍵技術問題的解決、技術風險、技術公升級方向、技術方案評價,競爭對手技術分析等。以《需求分析》為基礎,進行詳細的技術分析(產品的效能和實現方法),列出本專案需要使用什麼技術方案,為什麼,有哪些技術問題要解決 ,估計開發期間會碰到什麼困難,技術方案以後如何公升級,對本專案的技術有什麼評價等。

5. 《系統分析》——包括功能實現、模組組成、功能流程圖、函式介面、資料字典、軟體開發需要考慮的各種問題等。以《需求分析》為基礎,進行詳細的系統分析(產品的開發和實現方法),程式設計師根據《系統分析》,開始在專案主管的帶領下進行編碼工作。

6. 《資料庫文件》——包括資料庫名稱、表名、欄位名、字段型別、字段說明、備註、字段數值計算公式等。以《系統分析》為基礎,進行詳細的資料庫設計,必要時可以用圖表解說,特別是關聯式資料庫。

7. 《功能函式文件》——包括變數名、變數初植、功能、函式名、引數、如何呼叫、備註、注意事項等。以《系統分析》為基礎,進行詳細的說明,列出哪個功能涉及多少個函式,以便以後程式設計師修改、接手和擴充套件。

8. 《介面文件》——包括軟體外觀、介面素材、編輯工具、檔名、選單、按鈕和其它介面部件的要求,這裡與軟體完成後的執行介面是一致的。

9. 《編譯手冊》——包括伺服器編譯環境、作業系統、編譯工具、編譯器版本資訊、目錄說明、程式生成、源程式檔案列表、makefile配置及其相關程式的對應關係列表。客戶端的編譯過程、編譯結果、編譯示例、編譯環境、作業系統、編譯工具、原始檔列表和製作安裝程式的過程。

10. 《qa文件》——包括產品簡介、產品原理、產品功能列表、功能描述、功能流程、執行結果、資料庫結構、測試要求等,提供給軟體測試人員使用。

11. 《專案總結》——包括專案簡介、專案參與人員和開發時間、專案風險、管理過程、專案功能列表、專案結構特點、技術特點、對專案的公升級建議、對以後的專案的建議、人員工作情況等。

軟體開發文件

你會寫軟體開發文件嗎?

如今,軟體開發越來越複雜,軟體的功能也越來越豐富。而幾乎所有成熟的商業軟體,都是乙個開發團隊齊心協力的血汗結晶。羅馬不是一天建成的。當我們震撼於microsoft windows的驚世巨著的同時,也道聽途說了一些微軟公司軟體工程是如何的完善和規範。軟體專案管理的成敗是控制開發成本的關鍵環節。這裡面,...

軟體開發文件結構

1.概述 1.1 編寫目的 1.2 定義 1.3 關鍵字 1.4 參考資料 2.總體設計 2.1 需求規定 2.2 執行環境 2.3 基本設計概念和處理流程 2.4 結構 2.5 功能需求與程式的關係 2.6 人工處理 2.7 遺留問題 3.介面設計 3.1 使用者介面 3.2 外部介面 3.3 內...

軟體開發文件分類

如今,軟體開發越來越複雜,軟體功能也越來越豐富。而幾乎所有成熟的商業軟體,都是靠乙個開發團隊齊心協力的血汗結晶。羅馬不是一天建成的!當我們震撼於microsoft windows的驚世巨著的同時,也道聽途說了微軟公司軟體工程是如何的完善規範。的確,集數百名員工幾年的共同努力之大成,軟體專案管理的成敗...