SuperAPI AI 工具集

doc-generator

通用与其它

查看项目

更新于 10-16 09:44

技能介绍

用途:从代码注释、API 规范和数据源自动提取、转换、校验并格式化文档,基于 ETVF 流水线(提取→转换→校验→格式化)。可生成 API 参考文档、README,或把已有文档转换为 Markdown,支持单文件与整目录批量处理。

主要能力:提取 JSDoc/Docstring/Go doc 注释、API 端点与参数、代码示例;标准化结构并套用模板;校验 schema、链接与完整性;输出 Markdown,可选生成 HTML、PDF 及导航索引。提供 GENERATE(单文件/模块)、BATCH(整目录,每批最多 100 个文件)、CONVERT(如 Markdown↔HTML/PDF、JSDoc/OpenAPI→Markdown)三种模式。质量门槛包括完整性≥95%、准确度≥90%、链接有效性 100%、总分≥85/100。支持中英双语输出,输入 schema 含 sources(path/type/language/include/exclude)、extraction(doc_style 默认 jsdoc、是否抽取示例/私有/内部)、options(locale、bilingual)。

使用方式:以源文件或目录为输入,指定输出路径与模板即可。示例如“为 src/auth.js 生成API文档,包含所有公共函数”,输出 docs/auth.md;批量示例输出 index.md、api/、guides/ 及 search-index.json。转换示例:convert README.md to README.pdf --theme=github。

限制与边界:不编写内联代码注释、不做代码审查、不生成测试、不写营销文案;不能实时连接在线 API 自动发现端点,需提供 OpenAPI 规范或代码文件。处理超过 10000 条记录需显式确认。不静默丢弃源内容,跳过段落会记录原因;跨引用必须做链接校验。错误处理包括跳过错解析文件、隔离违规记录、标记断链、归一化编码等,隔离率过高或严重解析错误过多会中止。附带的 UTE 自改进钩子会记录调用与反馈数据至本地审计文件。