[查核點文件]系統使用手冊撰寫重點分享

諶玟萁 Elly Shen 2021/09/16 18:05:01
75

 

分享原因

  大部分的專案都會需要交付查核點文件,「系統使用手冊」就是其中之一。系統使用手冊的重點是能夠讓不熟悉系統、第一次使用系統的人,閱讀手冊後都能夠快速地自行操作系統

系統使用手冊需要包含哪些內容

1.大綱:

  有些專案會在RFP文件裡面提供,因此就必須依照文件要求的項目進行撰寫。若RFP文件並無規定項目,建議可參考其他專案的大綱項目來進行調整。一個好的大綱內容,可以讓使用者快速的找到相對應的內文解決當下的問題

2.圖文並茂:

     ·圖片

     在某些情況下,使用者可能沒有那麼多時間閱讀文字,因此圖片的內容很重要!

舉例來說

A-貼上一張系統畫面

B-貼上一張系統畫面且於畫面中使用「紅框標記」加上「箭頭」及「數字①②③

     沒時間閱讀文字的使用者,此時看A圖後必須搭配文字才能了解操作步驟;看B圖卻能夠快速的從畫面直接執行步驟,可以減少使用操作手冊的時間。

     ·文字

     畢竟並非所有的使用者都有技術背景,能夠理解系統的專有名詞。使用簡單易懂的文字進行描述,能夠讓使用者更快上手使用系統。

3.敘述流程:

  撰寫操作畫面時,請記得從畫面「由上到下,由左至右」來進行敘述。可以先從大項目說明,再進行細節的功能說明。若細節的功能項目搭配「步驟一、步驟二...」來進行描述,更能讓使用者進入目前的操作情境,同時也能確認自己目前的步驟是否正確。

4.圖片標號:

  一個好的系統操作手冊,會使用許多系統畫面的圖片來搭配說明。因此善用圖片的標號,不但可以快速地更新整份文件的圖標,也能夠一鍵更新圖目錄的「頁碼+內容」喔!

另外,「圖標號+文字」的說明,也可以加速使用者閱讀手冊時,直接從圖目錄裡找到相對應的頁碼來確認操作流程。

範例

A

B

 

    不難發現,B的圖目錄增加了文字描述,讓使用者閱讀圖目錄時,能夠快速找到目前相對應的系統畫面

結論

  寫文件不可怕,可怕的是不知道寫的重點。以上提供撰寫系統使用手冊」的重點分享,提供大家未來撰寫文件時做參考!

 

諶玟萁 Elly Shen