如何寫出讓人一看就懂的操作說明

客戶寫信給客服、新進員工一直問同樣的問題、「照著說明做」的任務還是出錯。問題通常出在說明本身:撰寫者對這項任務太熟悉,反而看不出新手會在哪裡迷路。以下七個原則,能讓說明一次就發揮作用,無論是使用手冊、說明中心文章,還是標準作業流程。

1. 一份說明一項任務
「如何設定您的帳戶」範圍太廣。「如何變更密碼」和「如何新增團隊成員」是兩份不同的說明。讀者只找一項任務,找到、完成,然後離開。
2. 先說明成果與所需條件
在開頭兩行說明讀者會達成什麼,以及開始之前需要準備什麼:存取權限、一個檔案、密碼、十分鐘的時間。沒有什麼比做到第 7 步才發現一開始就該準備某樣東西更令人沮喪了。
3. 步驟編號,每步一個動作
每個步驟只有一個動作,並以動詞開頭:「開啟『設定』」、「點選『儲存』」。如果某個步驟裡出現「然後」,那就是兩個步驟。編號能讓讀者知道自己做到哪裡,客服也能直接說「請看第 4 步」。
4. 用讀者的用詞,而不是您的
按鈕和選單的名稱,要完全照讀者在螢幕上看到的寫。避免內部術語和縮寫;如果非用某個術語不可,第一次出現時要加以解釋。
5. 說明應該出現的結果
在重要步驟之後描述結果:「畫面出現綠色訊息:已儲存」。讀者就知道自己沒做錯,一旦出問題也能立刻察覺。
6. 警告放在步驟之前,而不是之後
「點選『刪除』之前,請先匯出資料:已刪除的資料無法復原。」放在步驟之後的警告,就太遲了。
7. 找新手測試
把說明交給從沒做過這項任務的人,在旁邊觀察但不出手幫忙。每一個他們猶豫、發問或出錯的地方,都是需要改寫的地方。五分鐘的測試,能找出比重讀一小時更多的問題。
圖片與架構
- 螢幕截圖用於螢幕上的操作步驟,並標出正確的按鈕;介面改變時要記得更新。
- 標題用於較長的流程,讓讀者能直接跳到需要的部分。
- 「如果……怎麼辦」小節放在結尾,處理常見問題:「如果沒有收到郵件,請檢查垃圾郵件資料夾」。
重點整理
一項任務、先說明成果與條件、編號且每步一個動作、使用讀者的用詞、說明預期結果、及時給出警告,並找真人測試。如果您需要撰寫使用手冊、一系列說明中心文章或作業流程,可以訂購使用手冊與 SOP:您描述產品或流程,就能拿到清楚、有條理的說明。只有在您驗收作品後才會撥付款項。