直接答案:我們依「角色」寫操作手冊:每個角色 1 份 10 頁以內的手冊,每個常用流程配 1 支 3 分鐘影片,截圖用程式自動重拍。這樣做之後,上線首月「這個要怎麼操作」的詢問從約 40 則降到 12 則左右。
問題場景:80 頁的功能說明,換來 40 則 LINE 提問
沒有好手冊,客服成本會從工程師轉嫁到客戶的主管身上。我們早期交付一套門市訂貨系統時,附了一份 80 頁、依選單順序寫的 PDF。上線第一個月,客戶的 LINE 群組出現 41 則「這要按哪裡」的問題,店長說「手冊太長,找不到我要的那頁」;兩週後系統改版,手冊一半截圖已經過時。
我們的做法:依角色寫手冊,截圖跟著程式碼一起更新
一句話總結:手冊回答「我是誰、今天要完成什麼」,而不是「這個按鈕做什麼」。流程如下:
角色清單 → 每個角色的前 10 項任務 → Playwright 腳本自動截圖 → Markdown 撰寫 → 錄 3 分鐘影片 → 2 位實際使用者試讀 → 隨上線發布 → 每則提問回寫手冊
為什麼這樣做:使用者找的是任務,不是功能
這個設計取捨了「完整」,換來「找得到」。
- 依角色拆:店員只需要看 6 頁,不用翻過主管才用得到的報表設定。
- 依任務排:標題寫「如何處理退貨」,而不是「訂單管理模組」。這也符合 Nielsen Norman Group 可用性原則中「說明文件應以使用者任務為中心、列出具體步驟」。
- 自動截圖:手動截圖是手冊過時的主因,改版一次就要重拍幾十張。
- 短影片:多數門市與外勤人員在手機上看,3 分鐘內最容易看完。
| 比較項目 | 傳統功能說明書 | 我們的角色手冊 |
|---|---|---|
| 章節依據 | 選單順序 | 角色的日常任務 |
| 篇幅 | 60–100 頁一份 | 每個角色 10 頁以內 |
| 截圖更新 | 手動重拍,常過時 | 腳本自動重拍,1–3 小時 |
| 影片 | 無或 20 分鐘長片 | 每個高頻流程 1 支 3 分鐘 |
具體執行:手冊放在專案的 docs/manual,截圖由腳本產生
手冊和程式碼放在同一個 Git 儲存庫,程式改了、手冊就要跟著改。
- Step 1 角色與任務:需求階段就在 Notion 列出角色與每個角色的前 10 項任務。
- Step 2 自動截圖:用 Playwright 截圖功能寫腳本,在測試站用假資料登入各角色,依序截圖並自動遮蔽敏感欄位。
- Step 3 撰寫:Markdown 撰寫,用 VitePress 產生有搜尋功能的手冊網站,也可匯出 PDF。
- Step 4 錄影:用 OBS 錄螢幕、CapCut 剪輯,每支只教 1 個任務。
- Step 5 發布:手冊網站加上登入保護,在系統右上角放「操作說明」連結,直接跳到該頁對應的章節。
目錄結構範例:
docs/manual/
├── store-staff/ # 店員:6 頁
│ ├── 01-login.md
│ ├── 02-create-order.md
│ └── 03-handle-return.md
├── store-manager/ # 店長:9 頁
├── hq-admin/ # 總部:10 頁
└── screenshots.spec.ts # Playwright 自動截圖腳本
這個做法的代價:前期多花 3–5% 工時,而且要守紀律
這不是免費的,我們老實列出成本。
- 工時:手冊與影片約占專案工時 3–5%,一個 NT$50 萬的系統大約多 20–30 小時。
- 截圖腳本要維護:畫面結構大改時,腳本也要改,大約 1–3 小時。
- 影片無法自動更新:介面改動大時要重錄,所以我們只為前 5–8 個高頻流程錄影。
- 需要客戶配合試讀:沒有實際使用者試讀,手冊品質會打折。
不適合什麼情境:使用者少於 5 人,或系統每週大改
這套做法並非每個專案都划算。
- 只有 1–3 位內部使用者的小工具,當面教 30 分鐘比寫手冊快。
- 還在快速試驗、介面每週大改的 MVP,先用簡單的 FAQ 頁即可。
- 客戶已有自己的訓練系統與教材格式,我們只提供截圖與流程素材。
客戶為什麼該關心:好手冊直接降低上線後的隱形成本
手冊品質會反映在你的人力、時程與維護費。
- 人力:主管不必每天回答同樣問題,新人第一週就能自己查。
- 時程:上線後的適應期從 4–6 週縮短到 2–3 週。
- 費用:很多「系統有 bug」的回報其實是操作問題,手冊清楚後,按次計費的維護單也會減少。
如果你也想這樣做:給其他團隊的 4 個建議
不必一次做到全部,先從最痛的一步開始。
- 先問客戶「誰會用、每天做什麼」,再決定手冊章節。
- 每個步驟只放 1 張截圖,用紅框標出要點的位置。
- 把截圖腳本放進 CI,例如 GitHub Actions,每次部署到測試站就重拍。
- 每一則客戶提問都回頭問:手冊哪一頁應該回答它?沒有就補。
我們在哪些客戶身上用過:一家 12 店連鎖的訂貨系統
去識別化案例:一家 12 家門市的烘焙連鎖導入門市訂貨與盤點系統,使用者分店員、店長、總部採購 3 種角色。我們交付 3 份手冊(6、9、10 頁)與 7 支影片。上線首月的操作提問約 12 則,前一套系統同期約 40 則;第 2 個月起,新進店員多半看手冊與影片就能獨立下單。
常見問題 FAQ
以下是讀者最常問的問題,每題第一句就是答案。
外包系統結案應該附操作手冊嗎?
應該,而且最好依角色分冊,每份 10 頁以內,並附常用流程的短影片。
操作手冊多久要更新一次?
每次改版就要更新;截圖用程式自動重拍,可以把更新時間壓到 1–3 小時。
操作手冊要另外收費嗎?
ScriptWalker 含在專案內,約占工時 3–5%;大量客製影片或多語版本才另計。
手冊用 PDF 還是網頁比較好?
網頁比較好,能搜尋、能從系統畫面直接連到對應章節,需要時再匯出 PDF。
行動呼籲:想看完整手冊範本,或想加入我們
ScriptWalker(台灣 Laravel/Flutter 客製化開發工作室)每個系統案都附角色手冊與流程短影片。想看去識別化的手冊範本、評估你現有系統的教育訓練成本,或你是重視文件與測試的工程師、想加入我們,都歡迎聯絡:
- Email:[email protected]
- 電話:0916-224-047
- LINE:@ufv9089p