工作兩年，我已經替 5 個 SaaS 產品寫了技術文件。
過程中我發現：
現代人很沒耐心。5 分鐘內他不知道產品怎麼用，就會關閉網頁再找其他試用品。
公司失去了一個願意付費的潛在客戶。
怎麼辦呢？你需要一份 Tutorial 技術文件！
Tutorials（教學文件）瞄準的對象是超級新手、第一次使用產品的人。
想像我們在教一個小朋友下廚。
教小孩煮什麼並不重要，重要的是
- 讓他知道在廚房裡要注意些什麼
- 享受做菜的樂趣
- 最後成功做出一道菜（例如自己煎出荷包蛋！）。
關鍵是「建立一些簡單的任務，讓使用者試著去完成看看」。
例如 Mac 上的軟體- Raycast 讓使用者快速完成 5–10 個小任務，就學會產品 80% 的功能了。
Raycast Cover
那該怎麼寫出一份好的 Tutorial (教學)文件呢？
下面是我總結的 6 個訣竅。
訣竅 1. 教學起手式，自己從頭到尾做一遍
拿出一張白紙，寫下要開始使用產品的每一個步驟。(你想先打在筆記軟體上也行)
這裡的訣竅是：你必須自己從 0 到 1 完成過產品的操作，並且紀錄你的每一個動作。許多的教學文章都會犯一個錯，步驟跳太快啦！你應該也有這樣的經驗，說明書上明明是寫第 2 步，但真實狀況是你得自己多做 5 個動作。
寫教學文件的起手式，一定是自己從頭到尾做一遍。
訣竅 2. 一個教學步驟，只寫一個動作
這樣讀者才能跟上腳步。
舉個例子，我們該怎麼寫「註冊流程」呢？我建議：
- (o) (1)點擊註冊按鈕 (2)輸入基本資料
- (x) 「註冊並輸入基本資料」
每個步驟只做一件事情。
訣竅 3. 在教學文件開頭，先預告有幾個步驟
這樣讀者才能預測要花多久時間閱讀。
例如
- 3 個步驟開始交易
- 5 個步驟完成串接
- 10 個步驟製作第一張圖卡
想想你的閱讀體驗就知道了。
你看到一份不知道要花多久時間才能完成的教學，下一步通常是…往下滑到底。然後 murmur “看起來好複雜”，接著滑鼠游標移動到瀏覽器的右上角點擊 X。
先預告，讀者才有耐心讀下去。
訣竅 4. 教學步驟中不展開細節
遇到繁瑣的步驟時，Tutorial 文件不需要展開操作細節。
例如「輸入基本資料」包含了姓名、電話、Email、地址…，不需要特別提及要填寫什麼欄位。
這些屬於「說明類」的內容，可以放到 How-to 或是 Explanation 文件中說明。
這樣做的好處是你的文件會看起來很簡潔。
訣竅 5. 教學文件中要搭配截圖
一圖勝千言，文字搭配截圖最好懂。
這裡有個提升圖片質感的訣竅。把圖片複製到 Figma 中，在 Effect 欄位新增陰影 (Shadow)。
加上陰影可以大幅提升圖片的質感。
訣竅 6. 每個教學步驟都要取個標題
標題要劃重點的作用，5–10 個字最好。
例如 “開始使用產品之前您需要一個帳號，點擊按鈕登入頁面進行註冊。”
可以取個 “註冊產品帳號” 的標題。
試試看替你的公司產品寫份 Tutorial 文件吧！
快速複習寫 Tutorial 文件的 6 個訣竅：
- 教學起手式，自己從頭到尾做一遍
- 一個教學步驟，只寫一個動作
- 在教學文件開頭，先預告有幾個步驟
- 教學步驟中不展開細節
- 教學文件中要搭配截圖
- 每個教學步驟都要取個標題
你可以看看 我寫的 Tutorial 文件， 會更了解上面的說明。
覺得這篇貼文實用嗎？你可以
- 📰 歡迎 訂閱電子報 加入 2300+ 學習愛好者的行列，每週 1 個學習行動建議！
- 🧑💻 常滑 Facebook 嗎？可以 追蹤我，就可以看到我的最新想法啦～
- ❤️ 如果你覺得文章寫的不錯，可以對文章按愛心讓我知道
