用途:撰写或修订已发布的、面向消费方(集成客户端开发者)的 API 参考文档。目标是让开发者仅凭该参考即可完成认证、发出首次成功调用,并正确使用每个操作;文档中每个端点、字段与错误都必须可追溯到上游 api-spec 契约,不得漂移或编造。
主要能力:该技能提供撰写方法与质量标准,而非章节清单。它假定有两个协作者:提供章节结构的 api-reference 模板工具,以及用于将入门叙述、示例与约定建立在成熟公开 API 文档实践之上的深度研究能力。输入包括上游 api-spec(工程线协议契约),以及存在时的 feature-spec(使用上下文)与 architecture-doc(认证/版本上下文)。参考文档是契约之上的叙述、入门与示例层,补充契约未涵盖的快速上手、认证走查、示例、分页/错误/限流/弃用指引与排障,但不重新定义或取代契约。
使用方式:先从模板工具获取章节结构;读取上游文档并以 api-spec 的操作作为端点覆盖清单;默认手写模式,若端点目录由 OpenAPI 自动生成则保留生成结果,转而补充叙述、示例质量与漂移检查;用深度研究夯实约定;按章节方法填充内容;交付前对照可用性与契约一致性标准自检;修订时只改增量并重新同步受影响区块。
适用场景:从上游 api-spec 撰写面向消费方的 API 参考;记录逐端点用法、入门与认证、事件/Webhook、分页、错误与限流、代码示例、版本与弃用;为模板填充内容;在自动生成目录之上补充人工叙述与漂移检查;上游契约变更时修订现有参考。
限制:不用于撰写工程线协议契约本身、终端用户产品指南或开发者采用指南、数据模型或系统架构文档,也不用于评审或评分已完成的 API 参考。若缺少预期输入文档,应基于 api-spec 继续并将缺口标为显式假设,绝不编造端点、参数、字段、错误或事件;若某操作无法达到标准,应作为阻塞项上报。具体命令与安装方式暂未提供。