軟件工程文檔

文檔是軟件開發使用和維護當中必備的資料，文檔主要是管理人員、開發人員、操作人員、用戶人員之間進行協商溝通的橋梁。

1.可行性分析文檔

• 主要是說明軟件在經濟上，技術上和市場情景等方面的可行性。
• 根據這個文檔，公司判斷軟件能否實現，客戶要考慮是否把項目給公司，公司考慮是否要接這個項目。

2.需求文檔

• 用戶與開發人員進行交流，開發人員根據和用戶不斷地進行交流，把用戶的需求寫成文檔。需求文檔是用戶和需求人員溝通的橋梁，需求人員根據用戶的要求來變更需求文檔。
• 需求文檔對所開發軟件的功能、性能、用戶界面以及運行環境等作出詳細的說明。也就是說，需求文檔主要是寫明軟件有什么功能，性能，誰用這軟件等內容。

3.數據庫設計文檔

• 數據庫設計文檔，有些公司是由DBA（數據庫管理員）設計的，有些公司是由架構師設計的，有些是由程序員設計的。該文檔給出數據邏輯描述和數據采集的各項要求，為生成和維護系統的數據文件做好準備。

4.概要設計文檔

• 由公司的架構師，項目經理來完成。
• 概要設計文檔說明系統的功能分配、模塊劃分、程序的總體結構、輸入輸出及接口設計、運行設計、數據結構設計和出錯處理設計等，為詳細設計奠定基礎。
• ?架構師根據需求文檔設計系統的整體架構，項目經理列出開發計劃，架構師完成概要設計之后，就開始給程序員分配任務，進行下一階段。

5.詳細設計分檔

• 程序員拿著架構師設計出來的概要設計文檔，開始編寫詳細設計文檔，所以一個項目里面會有很多份詳細設計文檔，因為每一個程序員負責一部分的功能，每個人寫出來的詳細設計文檔都不一樣。
• 詳細設計文檔，詳細的列出開發的方式，如何編寫代碼等內容，著重描述功能模塊是如何實現的，包括算法和邏輯流程等。

6.單元測試文檔

• 一般由程序員完成，這個文檔因公司而異，有些公司寫，有些公司不寫。單元測試文檔主要是從代碼級別來測試系統（寫單元測試，測試自己寫的代碼），也叫白盒測試。

7.測試計劃：

• 測試計劃由公司的測試部門的測試人員進行測試，主要是在文檔中列出測試的方案，測試的結果等。
• 測試計劃主要是站在客戶的角度對系統的功能進行測試，也叫黑盒測試。

8.測試分析報告

• 測試完成后，有些公司會寫一個測試分析報告，把一些共性的問題挑出來，為以后的開發做個經驗的積累。

9.項目開發總結報告

• 一般是系統部署后，由項目經理對系統進行一個大的總結，看系統實際完成的情況與系統計劃實施的情況有什么差異？包括進度，資金、人力的投入情況等，總結出經驗和教訓。

10.用戶手冊

• 詳細描述軟件的功能、性能和用戶界面，使用戶了解如何使用該軟件。用戶手冊就相當于我們平時看的說明書一樣，說明你的系統如何使用。

11.操作手冊

• 針對的對象主要是操作員，為操作員了解軟件的運行情況和操作方法知識。

12.開發進度月報

• 由公司的項目經理根據當前開發系統的進度填寫。

?

posted on 2013-01-19 20:05 雨落天涯 閱讀(...) 評論(...) 編輯 收藏

轉載于:https://www.cnblogs.com/mingxuanyun/archive/2013/01/19/3084233.html

總結

以上是生活随笔為你收集整理的软件工程文档的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。