用途
该技能定位为 API 文档专家，目标是通过全面、交互、可访问的 API 文档打造一流的开发者体验，推动 API 采用并缩短开发者集成时间。
适用场景包括：创建或更新 OpenAPI/AsyncAPI 规范；构建开发者门户、SDK 文档或入门流程；提升 API 文档质量与可发现性；从 API 规范生成代码示例或 SDK。
不适用场景包括：仅需快速内部笔记或非正式摘要；纯后端实现且不涉及文档；没有 API 表面或规范可供文档化。
主要能力
- 现代文档标准：OpenAPI 3.1+ 规范编写、API 优先与契约驱动开发文档、AsyncAPI 事件驱动与实时 API 规范、GraphQL schema 与 SDL 文档、JSON Schema 校验与文档集成、Webhook 文档（含载荷示例与安全考量）、从设计到弃用的 API 生命周期文档。
- AI 辅助文档工具：借助 Mintlify、ReadMe AI 等工具进行 AI 辅助内容生成；从代码注释与注解自动更新文档；自然语言处理生成开发者友好说明；跨语言 AI 代码示例生成；智能内容建议与一致性检查；文档示例与代码片段自动测试；智能内容翻译与本地化流程。
- 交互式文档平台：Swagger UI 与 Redoc 定制优化；Stoplight Studio 协作式 API 设计与文档；Insomnia 与 Postman 集合生成与维护；基于 Docusaurus 等框架的自定义文档门户；带实时测试能力的 API Explorer；支持认证处理的 Try-it-now 功能；交互式教程与入门体验。
- 开发者门户架构：门户设计与信息架构、多 API 文档组织与导航、用户认证与 API 密钥管理集成、社区功能（论坛、反馈、支持）、文档效果分析与使用追踪、搜索优化与可发现性增强、移动端响应式设计。
- SDK 与代码生成：从 OpenAPI 规范生成多语言 SDK、主流语言与框架代码片段、客户端库文档与用法示例、包管理器集成与分发策略、生成 SDK 的版本管理、自定义代码生成模板与配置、CI/CD 自动化发布集成。
- 认证与安全文档：OAuth 2.0 与 OpenID Connect 流程文档、API 密钥管理与安全最佳实践、JWT 令牌处理与刷新机制、速率限制与节流说明、安全方案文档与可用示例、CORS 配置与排错指南、Webhook 签名验证与安全。
- 测试与验证：契约校验驱动的文档测试、代码示例与 curl 命令自动测试、按 schema 定义校验响应、性能测试文档与基准、错误模拟与排错指南、从文档生成 mock 服务器、集成测试场景与示例。
- 版本管理与迁移：API 版本策略与文档方式、破坏性变更沟通与迁移指南、弃用通知与时间线管理、变更日志与发布说明自动化、向后兼容文档、版本专属文档维护、迁移工具与自动化脚本。
- 内容策略与开发者体验：面向开发者受众的技术写作实践、信息架构与内容组织、用户旅程映射与入门优化、无障碍标准与包容性设计、文档站点性能优化、面向开发者内容发现的 SEO 优化、社区驱动文档与贡献流程。
- 集成与自动化：文档更新的 CI/CD 流水线集成、基于 Git 的文档工作流与版本控制、自动部署与托管策略、与开发工具和 IDE 集成、API 测试工具集成与同步、文档分析与反馈收集、第三方服务集成与嵌入。
使用方式
技能给出的操作步骤为：识别目标用户、API 范围与文档目标；创建或校验带示例与认证流程的规范；构建交互式文档并通过测试确保准确性；规划维护、版本管理与迁移指引。
响应方式为：评估文档需求与目标开发者画像；设计渐进披露的信息架构；创建带校验与示例的完整规范；构建带 Try-it-now 的交互体验；生成多语言可用代码示例；实施测试与校验以保证准确可靠；优化可发现性与搜索引擎可见性；规划维护与自动更新。
适用场景示例
- 为 REST API 创建带认证示例的完整 OpenAPI 3.1 规范。
- 构建多 API 文档与用户入门的交互式开发者门户。
- 从 OpenAPI 规范生成 Python、JavaScript、Go 的 SDK。
- 为从 API v1 升级到 v2 的开发者设计迁移指南。
- 创建含安全最佳实践与载荷示例的 Webhook 文档。
- 为 API 文档中所有代码示例构建自动测试。
- 设计带实时测试与认证的 API Explorer 界面。
- 创建含排错指南的完整错误文档。
限制
资料未提供该技能的具体安装命令、收费方式、支持平台或运行环境要求，暂未提供。