Zc Developer Experience Audit

开发者体验审计

zmice 746abbf 2.6 KB Updated

File contents

开发者体验审计

何时使用

  • 功能、CLI 或文档已经实现,需要从真实开发者视角做一次走查时
  • 发布前、合并前,确认 getting started 和安装链真的能支撑最小成功路径时
  • multi-perspective-review 已完成,但需要验证当时的 DevEx 假设是否在实做后仍成立时
  • onboarding、安装、配置、首次运行或错误恢复链路刚发生变更时

输入前提

  • 待审计的实现已经可运行,而不是只停留在计划或伪代码
  • 已明确目标开发者是谁,以及最小成功路径是什么
  • 已有开发者会实际依赖的入口材料,例如 README、安装说明、CLI 帮助或示例命令

执行步骤

  1. 先定义审计场景:目标开发者画像、运行环境、起点文档和期望的首次成功结果
  2. 按 getting started 和安装链从头执行,不跳过任何“大家都知道”的隐含前置条件
  3. 验证首次成功路径是否清晰可达,包括安装、配置、运行第一条命令以及看到预期结果
  4. 检查失败回流:当命令失败、配置缺失或依赖不满足时,错误信息和文档是否告诉开发者下一步怎么做
  5. 记录所有问题,并区分 blockermajor frictionminor friction,明确问题落点在代码、CLI、文档还是环境假设
  6. 输出结论和修复建议,决定是放行、修后重审,还是阻断发布/合并

通过标准

  • 新开发者能靠现有入口材料完成最小成功路径
  • 安装链、配置链和首次运行链没有隐形步骤
  • 错误信息与文档足以支持失败后的回流,而不是让人猜
  • 审计结论能落成具体修复项,而不是停留在“体验一般”

阻断标准

  • getting started 无法独立支撑起步,必须依赖口头知识或仓库历史
  • 安装链、配置链或首次成功路径存在实际断点
  • 失败后没有可执行的回流路径,错误信息或文档不足以指导恢复
  • 关键路径需要额外试错才能完成,且试错成本会显著拖慢新开发者

相关原则

  • DevEx 不能只在计划里看起来合理,必须在实现后真实走一遍
  • 首次成功路径是最重要的开发者体验信号
  • 审计结果必须能回流成具体修复动作

与其他技能的衔接

  • multi-perspective-review 负责实现前评审,这里负责实现后的真实实测
  • 常与 verification-before-completion 配合,把体验结论建立在实际运行证据上
  • 如问题落在长期说明与使用材料上,可回流到 documentation-and-adrs

zmice/zc-qwen-extension/tree/main/skills/zc-developer-experience-audit commit 746abbfa00

Frequently asked questions

npx skillmds@latest add zmice/zc-developer-experience-audit