SuperAPI AI 工具集

tech-docs-generator

编程与开发

查看项目

更新于 10-16 03:42

技能介绍

用途:根据真实代码库生成或更新技术文档,覆盖 API 参考、架构概览、入门指南、组件文档、贡献指南、配置指南和迁移指南等类型。

主要能力:先扫描代码库,识别导出函数与类、API 路由(REST、GraphQL、tRPC)、配置与环境变量、数据库模型与迁移、组件层级与 props、类型定义、入口点及依赖;再按所选文档类型生成内容,并支持在已有文档基础上更新而非替换。

使用方式:技能启动时声明正在使用 tech-docs-generator。第一阶段用 Agent 工具并行派发子代理(subagent_type="Explore")分析代码,分析后暂停并汇总发现,询问需要哪些文档类型。第二阶段按需选择类型,输出路径如 docs/api-reference.md、docs/architecture.md、docs/getting-started.md、docs/components/[name].md、docs/contributing.md、docs/configuration.md、docs/migration/v[X]-to-v[Y].md;多种类型可并行派发子代理。第三阶段派发 doc-generator 代理生成,生成后逐节展示供审阅。第四阶段逐节确认准确性,批准后保存到 docs/ 目录,提交信息格式为 docs(<scope>): add/update <doc-type>。

适用场景:为项目补充或更新 API 参考、架构说明、新人入门、组件说明、配置与迁移文档。

限制与要求:必须先分析代码再生成,不得编造示例,代码片段须来自或经代码库验证;默认只记录公开/导出接口,除非明确要求;不得跳过审阅环节;不得重复其他文档已有内容。完成前需验证公开 API 签名、示例可运行、交叉引用有效、文档与当前代码一致,并运行文档中的命令确认可用。具体收费、价格与平台支持情况暂未提供。