Skip to content
Apothem
流水线命令

/ux-review

/ux-review —— 对 CLI 人机工效、文档与上手体验进行的开发者体验审查。

角色: UX 审查员 流水线位置: 堡垒

对 CLI 人机工效、文档与上手体验进行的开发者体验审查。

规范调用

/ux-review

带参数:

/ux-review [path/to/repo/] [--focus SURFACE] [--dry-run]

输入

具备 README、安装脚本与 CLI 入口点的已部署宿主仓库

输出

UX 发现项位于 _inputs/ux-review-findings.md

下游

审计审查序列的 UX 审查阶段

工作流阶段

该命令分为五个阶段:输入摄取、CLI 易用性遍历、安装流程与错误恢复审计、文档可发现性扫描,以及附带校验门的发现项输出。

失败模式

症状原因恢复
前置条件未完成依赖阶段尚未结束先完成上游阶段
质量门 FAIL输出未达到标准修复输出并重新运行
目标未部署目标缺少面向操作者的表面传入已部署的仓库根目录

示例

# Dry-run to preview what would happen
/ux-review --dry-run

# Execute against a host repository
/ux-review path/to/repo/

交叉引用

On this page