2008年5月26日 星期一

Q03 產出驗收文件(2)──使用手冊、API手冊與教學文件

系統是要給人使用的,因此完成後首先需要一份使用文件好讓使用者知道如何操作系統。使用手冊首先要說明如何安裝系統與啟動,接下來可依照Use Case依序編寫。操作相關的內容大致上有啟始狀態、操作順序、反應訊息與設定方式等小節;這些可以說是Use Case需求文件進一步的實作說明。

API手冊(包括Component與API)是給會碰到系統內部的人看的,需要維護系統的客戶或是未來接手維護與新增功能的人都需要這樣的文件,這樣才能夠知道如何對系統除錯以及應付需求的變更。如果API裡需要固定的幾個串連,也必須在手冊裡說明才不致造成誤用。試想,即使維護者已經想好需要做到的系統動作,可是對應系統動作的元件或方法很難找出來或是根本沒有被封裝為方便執行的方法,這樣是令人無法再繼續下去的(以前面臨的就是這種情況)。

為了讓使用者與設計者都能快速瞭解常用功能或方法的用法,有時會需要撰寫教學文件。教學文件的編輯會先收集常用的功能後,再編出一個實際的故事來串連所有的操作,藉由模擬真實的輸入與產出讓使用者親自體會實際的使用以期快速地進入狀況。

不過,教學文件只是輔助性質的,實際需要的還是使用手冊與API手冊這兩種。

沒有留言:

張貼留言