軟體工程文檔

來源:互聯網
上載者:User

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

1.可行性分析文檔

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

2.需求文檔

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

3.資料庫設計文檔

  • 資料庫設計文檔,有些公司是由DBA(資料庫管理員)設計的,有些公司是由架構師設計的,有些是由程式員設計的。該文檔給出資料邏輯描述和資料擷取的各項要求,為產生和維護系統的資料檔案做好準備。

4.概要設計文檔

  • 由公司的架構師,專案經理來完成。
  • 概要設計文檔說明系統的功能分配、模組劃分、程式的總體結構、輸入輸出及介面設計、運行設計、資料結構設計和出錯處理設計等,為詳細設計奠定基礎。
  •  架構師根據需求文檔設計系統的整體架構,專案經理列出開發計劃,架構師完成概要設計之後,就開始給程式員分配任務,進行下一階段。

5.詳細設計分檔

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

6.單元測試文檔

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

7.測試計劃:

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

8.測試分析報告

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

9.項目開發總結報告

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

10.使用者手冊

  • 詳細描述軟體的功能、效能和使用者介面,使使用者瞭解如何使用該軟體。使用者手冊就相當於我們平時看的說明書一樣,說明你的系統如何使用。

11.操作手冊

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

12.開發進度月報

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

 

相關文章

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.