SuperAPI AI 工具集

doc-generator

编程与开发

查看项目

更新于 10-16 02:36

技能介绍

用途:doc-generator 用于从代码、API 与规格说明生成文档,覆盖 API 文档、开发者指南、架构文档和用户手册。它属于认知/提示驱动模式,没有独立工具脚本,需在智能体上下文中调用。

主要能力:识别文档类型;从代码与注释、API 端点、示例和架构中提取信息;按模板生成文档,包含示例与故障排查;校验完整性、示例可运行性、清晰度和链接。可与开发者智能体集成,生成 API 文档、内联文档,并随代码变更更新文档。

使用方式:通过自然语言指令触发,例如“Generate API documentation for app/api/users”“Generate developer guide for this project”“Generate architecture documentation”“Generate OpenAPI specification from API routes”。文档结构建议采用渐进披露:Setup → Quick Start → Reference → Troubleshooting。

限制与要求:必须以代码为事实来源,不得描述期望行为;示例必须可复制运行并经验证;不记录消费者不需要的内部实现细节;代码变更时须重新生成文档。开始前读取 .claude/context/memory/learnings.md,完成后将新模式、问题、决策分别写入 learnings.md、issues.md、decisions.md。资料未提供具体安装命令、收费方式、支持平台或效果数据。