軟體文件歸類彙總

2021-08-25 01:35:03 字數 2966 閱讀 6534

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

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

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

產品文件包括:《產品簡介》、《產品演示》、《疑問解答》、《功能介紹》、 《技術***》、《評測報告》、《安裝手冊》、《使用手冊》、《維護手冊》、 《使用者報告》、《銷售培訓》等。

一、開發文件   

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

2. 《投標方案》--根據使用者的功能要求,經過與招標方溝通和確認,技術人員開始書寫《投標方案》,方案書一般包括以下幾個重要的章節:   

前言--專案背景、公司背景和業務、技術人員結構、公司的成功案例介紹等。   

需求分析--專案要求、軟體結構、功能列表、功能描述、注意事項等。   

技術方案--總體要求和指導思想、技術解決方案、軟體開發平台、網路結構體系等。   

專案管理--描述公司的軟體開發流程、工程實施服務、組織和人員分工、開發進度控制、軟體質量保證、專案驗收和人員培訓、軟體資料文件等。   

技術支援--公司的技術支援和服務介紹、服務宗旨和目標、服務級別和響應時間、技術服務區域、技術服務期限、授權使用者聯絡人等。   系統**--軟、硬體平台**列表、軟體開發費用、系統維護費用等。   

專案進度--整個專案的進度計畫,包括簽署合同、專案啟動、需求分析、系統分析、程式開發、測試維護、系統整合、使用者驗收、使用者培訓等步驟的時間規劃。   

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

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

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

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

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

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

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

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

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

二、產品文件   

1. 《產品簡介》--包括公司背景、產品概念、適用範圍、產品功能、功能特點、執行要求和公司聯絡位址。   

2. 《產品演示》--包括公司簡介、產品背景、產品描述、產品特點、產品作用、適用範圍、使用分析、功能模組、解決問題、合作夥伴、成功案例等。一般用power point或者vcd錄製軟體實現。   

3. 《疑問解答》--列出使用者關心的問題和處理方法。用於解答軟體的操作功能和解決使用者的疑難問題。   

4. 《功能介紹》--以《需求分析》為書寫基礎,包括軟體介紹、軟體結構、功能列表、功能描述和公司聯絡位址。   

5. 《技術***》--以《技術分析》為書寫基礎,包括功能實現、技術選型、關鍵技術問題的解決、技術方案特點、技術公升級方向等。   6. 《評測報告》--第三方權威評測報告。包括評測目的、評測範圍、評測環境、評測內容、實測資料、效能表現、結果分析和評測總結等。

7. 《安裝手冊》--包括系統環境、執行平台、產品安裝過程、初始環境設定、安裝記錄等。   

8. 《使用手冊》--包括產品簡介、功能列表、功能描述和解釋、功能操作、客戶服務和****等。   

9. 《維護手冊》--包括產品簡介、系統須知、初始環境設定、系統配置、資料管理和備份、技術問題解答和****等。   

10. 《使用者報告》--包括產品簡介、購買時間、使用目的、使用時間、使用地點、實施過程、出現問題和解決、產品總結和建議等。   

11.《銷售培訓》--包括專案簡介、產品功能、產品特點、商業優勢、系統執行環境、適用範圍、目標客戶等。

軟體相關文件彙總

對於軟體工程學科的同學都知道,軟體工程是一門技術含量高設計極其複雜的學科。為了控制好軟體產品質量和規範,就必須用大量的文件約束軟體工程的進度和狀態。浩大的軟體工程對於缺少工作和專案經驗的人來說,必然是摸不著頭腦不知從何開始。為了讓大家能夠快速適應標準的軟體開發過程,今天我為大家粗略的描述開發中需要的...

系統方案彙總文件

以許可權系統為例 文件內容如下 該文件主要闡述許可權系統設計方案 1 總結系統運用到的技術方案 2 用於指導該系統後台人員開發工作。系統業務不複雜,主要是crud 增刪改查 操作,所以採用單體架構,就能滿足當前系統需求。系統技術架構圖,如下 採用現今最流行 最成熟的springboot框架,spri...

軟體文件簡介

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