SuperAPI AI 工具集

api-doc-writer

编程与开发

查看项目

更新于 10-16 00:29

技能介绍

用途:api-doc-writer 用于创建全面、准确的 API 参考文档。它通过阅读源代码提取精确的方法签名,遵循 Diátaxis Reference 模式,面向信息型文档,对虚构方法或错误签名零容忍。

主要能力:发现并定位公共 API 表面;从源码复制精确签名(不转述);提取注释与错误条件;使用标准化模板(类型、函数、常量);编写完整可运行示例;验证签名与源码一致;按 Overview → Types → Functions → Constants → Examples 组织内容。

使用方式:手动调用,例如 /skill api-doc-writer 或 /skill api-doc-writer pkg/services/task。详细工作流见 ~/.claude/skills/api-doc-writer/references/WORKFLOW-STEPS.md,模板见 TEMPLATE-EXAMPLES.md,常见错误见 PITFALLS.md。输出为 Markdown 文件,通常放在 docs/api/[package-name].md、项目根目录 API.md 或 docs/reference/[module-name].md,并在文末附文档元数据与验证清单。

适用场景:为包、模块或主 API 编写参考文档;需要精确签名与完整覆盖时使用。

限制:不包含教程、操作指南或解释性内容;不写营销语言;不引用行号(用方法名);示例必须可运行且使用真实导入;性能声明需有基准证据。时间估算:小型 API 30-45 分钟,中型 1-2 小时,大型 2-4 小时,复杂 API 4-8 小时。