操作手冊很重要,
可以照著一個步驟一個步驟練習,避免上完課聽過就忘了的問題。
要怎麼寫才清楚呢?
以下是具體的參考做法和流程:
內容
用 PREP 結構化表達 ~ 講重點、解釋原因、舉例
操作手冊通常比較枯燥,開門見山先講重點就對了!
遵循 PREP 的表達框架是好的選擇。
- Point
先講重點就對了。
- Reason
解釋原因,讓人理解比較容易接受或記住。
- Example
將抽象的概念用具體的例子說明,是很重要的技巧。
- Point
人的記憶力有限,再次重點回顧是加深印象的好方法。
還有一點很重要,就是要 ~ 短!
這也是 tiktok, fb, ig, twitter, 微信 ... 這些短訊息平台成功的重要關鍵。
更詳細的說明,可以參考:
這最重要了!
不然寫了一堆沒有重點,寫的人沒成就,看的人也辛苦,浪費許多時間。
甚麼是重點呢?
不管是寫文件、手冊步驟或是整理 FAQ,其實都是 為了解決某個需求或問題。
透過 5why 追問法分析,就更容易分析出需求,找到要寫什麼 (內容重點):
- 需求是什麼? (需求)
- 目前會遇到什麼問題? (痛點)
- 該如何解決? (解法)
無論是下標題 or 其中的內容,
每一個最好都要具體,具體、具體、具體、就對了。
以下圖這個 FAQ 為例子
具體的「重點」包括:
- 標題
就包含兩個具體的元素:「痛點 (開會沒效率)、解法 (3 個步驟)」
- 內容
也包含兩個重點:「痛點、解法」
通常可以從以下 3 個方向整理:
- 使用者回饋
提出的需求 or 反應的問題
- 應用流程
這就是解決需求的方法,很重要
- 系統介面
因為當初會這樣設計,一定是為了解決某個問題
在「需求、痛點、解法、具體」的大原則下,
操作手冊的主要結構就會包含以下內容:
- 標題
通常是寫功能的名稱 or 需求。
更詳細的說明,可以參考:「標題,要怎麼下?」
- 內容
通常會包含以下元素:
- 定義 or 背景:這是基礎前提,
用別人可以理解的來解釋,如果讀者已經知道了,就可以省略。
- 需求:想要解決什麼問題? 這很重要嗎? (增加誘因)
- 解法:如何解決的主要流程 (主幹,
開門見山,先講重點
),為接下來的細節步驟整理思路,降低迷路的風險
- 附圖:為了有更清楚的目標,可以附上最終結果的圖
(一圖勝千言)
- 延伸閱讀:補充次要的資訊 or 延伸的操作
- 操作教學
「入口」最重要!避免一開始不得其門而入,
其他內容還可以包含:- 步驟:關鍵步驟、重要的相關步驟。
- 補充:提醒、常見問題、延伸閱讀。
- 截圖:一張圖勝過千言萬語,尤其是系統的操作教學。
以下是更詳細的說明:
- 操作重點
關鍵步驟,通常是功能的入口。
找得到功能,接著就可以順著介面引導操作。通常只要抓對線頭,結就解開來了。
- 其他重要操作
為了避免卡關 or 完整性考量,一定要放進來的步驟。
最多 1~2 個不需要截圖的就好,避免太複雜。
如果需要多個截圖的步驟呢?
建議另外成「常見問題、延伸閱讀」,避免干擾主要的流程和資訊。
- 提醒、小技巧、特別說明
列出容易忽略、誤解、混淆、遺漏的地方,這是避免卡關的重要技巧;
也可以列重要特色功能,例如專案討論可以通知到 LINE 群組。
- 常見問題
操作這個步驟時,可能會卡關的 or 遇到的問題,列出最重要的 2~3 個就好。
- 延伸閱讀
因為要短,可以寫的有限。
更多的細節,就可以透過「延伸閱讀」,提供其他手冊和文章。
- 截圖 (操作畫面)
儘量顯示完整的畫面 (方便比對),再用箭頭指向最重要的操作步驟 (通常是功能的入口)。
一張圖勝過千言萬語,尤其是操作,一定要有畫面,避免只有抽象的文字。
延伸閱讀:
-
標題,要怎麼下?
-
FAQ,怎麼寫?
用更具體的方式,展示上述的流程。