【軟工文件總結之後五個文件總結(重點篇)】

我是太陽啦啦啦發表於2015-11-14

前言:

       上篇部落格我們談論了前六個文件,這篇部落格我們重點考慮後面的幾個文件:下面我們分別來談論測試計劃、測試分析報告、專案開發總結、操作手冊、使用者手冊、開發進度月報。

分述:

(一)測試計劃:

           核心:測試計劃是描述要進行測試活動的範圍、方法、資源和時間進度的文件。
           內容:測試計劃共分為四個部分:分別是引言、計劃、測試設計說明、評價準則。
           注意的問題:這裡我們需要注意的問題是需要測試的模組的劃分,要儘可能的詳細些,包含各個方面,測試全部、仔細。
           文件編寫人員:測試管理人員
           預期讀者:測試人員

(二)測試分析報告:

                   核心:測試分析報告是在測試完成之後,在測試計劃的基礎上對測試結果的分析和綜合。

           內容:測試分析報告包含五個部分:分別是引言、測試概要、測試結果及發現、對軟體功能的結論、分析摘要、測試資源消耗。
           注意的問題:需要注意的是對測試結果要詳細的記錄,這需要測試的時候詳細的測試,對測試資源的消耗要準確估計,這需要在測試時記錄。
           文件編寫人員:測試管理人員
           預期讀者:專案經理,專案開發人員

(三)專案開發總結報告:

           核心:專案開發總結報告是在專案基本完成時編寫的!

           內容:專案開發總結報告包含四個部分:分別是引言、實際開發結果、開發工作評價、經驗和教訓。

           注意的問題:對於主要的功能和效能,需要詳細描述,方便以後的開發。對於基本流程,需要我們畫出流程圖,表現更直觀。經驗和教訓的總結有利於下次的系統的開發。

          文件編寫人員:專案管理人員

           預期讀者:專案經理,專案開發人員

(四)操作手冊:

           核心:操作手冊是告訴使用者如何正確的安裝和使用軟體。
           內容:操作手冊共包含六個部分
           注意的問題:在操作手冊中,要根據使用者資格能力來編寫使用者手冊,保證使用者可以看懂。
           文件編寫人員:系統開發人員
           預期讀者:開發人員        使用者

(五)使用者手冊:

           核心:使用者手冊為首次使用該系統的使用者說明使用方法,以及給已經使用過或者正在使用的使用者在使用過程中遇到問題時提供解決問題的方法。
           內容:使用者手冊包括四個方面的內容,分別是引言、用途、執行環境、使用過程。
           注意的問題:這裡需要注意的是不要把使用者手冊與操作手冊弄混,注意區別開來,具體區分見 

軟工文件總結之概括與圖形(簡要篇)中的操作手冊與使用者手冊

           文件編寫人員:系統開發人員
           預期讀者:使用者

(六)開發進度月報:

           核心:開發進度月報是專案在開發過程中的某一階段的總結。
           內容:開發進度月報共包括六個部分,分別是:標題、工程進度與狀態、資源耗用與狀態、經費支援與狀態、下個月的工作計劃、建議。
           注意的問題:開發進度月報可根據開發專案的大小進行彙報劃分,如果開發的系統較少,可分為開發進度週報等等,依據實際情況而定。
           文件編寫人員:系統開發人員
           預期讀者:系統開發人員   管理人員

總結:

       軟體開發文件軟體文件能起到多種橋樑作用,使它有助於程式設計師編制程式,有助於管理人員監督和管理軟體開發,有助 於使用者瞭解軟體的工作和應做的操作,有助於維護人員進行有效的修改和擴充,文件的編制必須保證一定的質量。它在軟體開發過程中具有重要的作用,所以我們要重視開發文件的編寫。



相關文章