CLI 用户体验检查清单
从从未使用过该 CLI 的非开发人员视角,对照固定评分标准对其进行审计。
何时调用
- “CLI 用户体验检查” / “检查我的 CLI” / “这个 CLI 是否直观”
- 在每次 CLI 发布之前
- 在添加或更改任何 CLI 命令之后
框架
每个命令输出必须回答三个问题: 现在是什么状况?· 下一步该怎么做?· 我可以做什么?
质量标准:命令的结束方式应如同 Codex 结束会话一样——一行简洁的状态说明,接着是准确的后续命令,并以醒目的颜色渲染,使视线自然落在“键入此命令”上。
评分标准(对每个命令逐项检查以下7点)
- 包含下一步操作。 每个成功/终止状态都以一条后续命令或明确的“操作完毕”结束。没有命令会静默停滞。
- 命令以颜色高亮显示。 可运行的命令使用统一强调色(青色加粗)。不应是纯文本,也不应是反引号文字。
- 无原始内部信息。 用户输出中不包含枚举值、状态码或术语。应使用人类语言,并附带一行说明(例如“dirty”变为“本地修改”)。
- 无静默挂起。 长时间运行或 stdio 命令会在 TTY 上自我声明,确保终端不会看起来卡死。
- 一致的基本元素。 所有命令共享同一套符号集、同一行/表格辅助工具和同一个“下一步”块,不针对每个命令重新发明。
- 错误信息附带修复步骤。 每个错误都明确指明解决该问题所需执行的确切命令。
- 引导首次运行。 裸调用或未登录状态显示带编号的快速入门指南。
如何执行
- 盘点每个命令及每个输出路径。阅读源代码,而不仅是
--help。 - 对每个命令,遍历成功路径、每个错误路径以及空状态。
- 对照7点评分标准进行评分。对每条发现引用
file:line。 - 对于不满足的点,写出具体的改进前后对比及确切的字符串。
- 输出:跨领域问题、每个命令的表格、按重要性排序的改进前后对比以及执行计划。
输出格式
一份发现文档:TL;DR 和核心问题、跨领域问题表格、每个命令的发现、每个修复的改进前后对比、执行计划。切勿未真实检查输出路径就写上“看起来没问题”。