用途:当主要工作是发布或刷新面向开发者的 API 文档时使用,覆盖端点/模式参考、快速上手与首次成功流程、任务导向集成指南、SDK 指南、Webhook 投递与验证文档、开发者门户导航与分组参考,以及随文档更新的迁移说明。
主要能力:按运行选择一种主模式(reference、quickstart、task-guide、sdk-guide、webhook-guide、migration-update),并区分 API 风格、受众、真实契约来源、文档载体、导航范围与维护状态;输出小而真实的文档包,如单个快速上手页、分组参考段、任务指南、SDK 指南、Webhook 指南、迁移说明、文档缺口/漂移清单或大型 API 的导航分组方案。
使用方式:先分类任务并确认边界技能,再收集最小可信证据(当前 OpenAPI/GraphQL 模式、认证要求、真实示例、错误与重试、分页、版本与迁移、发布约束),然后按开发者任务选择最小输出包,遵循以任务开头、尽早说明认证与环境、示例真实、记录运维现实、分离参考与流程、显式处理导航等规则,最后记录契约来源、示例来源、发布面、评审触发点与漂移热点。
适用场景:外部开发者、合作伙伴或内部集成方需要可用的 API 参考、快速上手或门户页面;已有 OpenAPI 或模式但缺少结构、示例、认证/设置、错误处理或导航;认证、版本、重试、分页、Webhook 或 SDK 变更后文档漂移;公开、合作或内部 API 发布需要开发者指南、迁移说明或可信示例;大型 API 需要分组、选择性发布或更清晰的门户结构。
限制:不用于设计资源、端点形态、模式规则或版本策略(应使用 api-design);不用于内部规范、ADR、运行手册或系统迁移流程(应使用 technical-writing);不用于终端用户产品 UI 上手或帮助中心文档(应使用 technical-writing);不用于实现认证/会话行为(应使用 authentication-setup);不用于发布说明或变更日志维护(应使用 changelog-maintenance);若尚无可信的 API 行为事实来源,应回到 api-design,而非凭空编写文档。资料未提供具体安装命令、收费或平台信息。