用途:这是开发者指南“撰写/评审”配对中的评审一半。当一份已完成的开发者指南(面向 SDK、库、CLI、框架或 API 平台的采用与集成叙述)需要在上线前做通过/修改决策时使用;也用于对修改后的指南复审,或对已发布指南的增量变更(amend)做增量评审。它只判断,不撰写、不修复、不重写指南。
主要能力:按固定的可采纳性+准确性清单(共十四项条件)逐条判定通过或缺口,条件包括:以目标组织内容;快速上手能到达可验证的首次成功(凭据来自环境变量、有验证步骤与预期输出);核心概念出现在集成配方之前;覆盖上游资料中的常见集成场景;独立的端到端教程;基于真实用法的生产最佳实践;Diátaxis 模式正确分离;链接而非复制 api-reference;代码示例可运行且与当前工具/API 一致;说明版本与迁移;不编造;增量变更的陈旧内容清扫;常见错误排错路径;可发现性(有起点指引)。
使用方式:先通读整份指南并收集上游资料(功能规格、api-reference 等),识别产品形态;再逐条判定,记录缺口位置与缺失内容;最后输出一行 VERDICT: approve 或 VERDICT: revise,随后列出可执行发现(失败条件、具体位置、修复方式)。
适用场景:作为集成开发者上线前的独立评审门槛;对修订稿复审;对工具新版本带来的增量变更做增量评审。
限制:不适用于撰写或修复指南、面向非技术用户的用户指南、api-reference 目录本身、工程设计文档或模板合规检查。评审标准随产品规模成比例,薄型工具可合理合并章节;但首次调用必须可验证、示例不得编造。资料未提供具体工具版本、价格或平台信息。