CLI UX 審查
從從未使用過該工具的非開發者視角,依據一套固定評分標準審查命令列工具(CLI)的使用者體驗。
何時應執行
- 「CLI UX 審計」/「審查我的 CLI」/「這個 CLI 直覺嗎」
- 每次 CLI 發佈前
- 新增或修改任何 CLI 命令後
審查框架
每個命令的輸出都必須回答三個問題: 目前狀態是什麼?· 下一步該做什麼?· 我可以做什麼?
品質標準:命令的結束方式應如同 Codex 結束一個 session — 一行純文字狀態,接著是確切的下一步命令,並以明顯的顏色呈現,讓眼睛自然落在「輸入這個」上。
評分標準(每條命令均需符合全部 7 項)
- 要有下一步操作。 每個成功/終止狀態都必須以下一步命令或明確的「你已完成」結尾,不能讓命令靜默停滯。
- 命令要有色彩標記。 可執行的命令應以一致的強調色(青色 + 粗體)呈現,不能是純文字或直接顯示反引號。
- 不能有原始內部術語。 使用者輸出中不應出現列舉值、狀態碼或專業術語。使用人類能理解的詞彙,並加上一行說明(例如將 "dirty" 改為「本地編輯」)。
- 不能有靜默停頓。 長時間執行或 stdio 命令必須在 TTY 上主動告知,讓終端機看起來不會被凍結。
- 一致的呈現慣例。 使用同一組符號、同一種行/表格輔助、同一種下一步區塊,並在所有命令間共用,而非為每個命令重新發明。
- 錯誤訊息要嵌入修正方法。 每個錯誤都應明確指出哪個命令可以解決問題。
- 引導首次執行。 直接執行(bare invocation)或未登入狀態應顯示編號的快速入門步驟。
執行方式
- 盤點所有命令及其所有輸出路徑。閱讀原始碼,而不只是
--help。 - 針對每條命令,走過成功路徑、每個錯誤路徑以及空白狀態。
- 對照 7 項評分標準逐一評分。對每項發現標註
檔案:行號。 - 若不符合標準,寫出具體的「修改前/修改後」字串範例。
- 輸出:跨命令的共通問題、各命令的評分表、排序後的修正前後對照、以及執行計畫。
輸出格式
一份發現報告:TL;DR 與核心問題、跨命令的共通問題表、各命令的詳細發現、每個修正的修改前後對照、執行計畫。若未實際走過輸出路徑證明,不得寫「看起來沒問題」。