SuperAPI AI 工具集

api-reference-writer

编程与开发

查看项目

更新于 10-16 06:16

技能介绍

用途:为 Flue 编写和重写 API 参考文档。以包可见的公开 TypeScript 接口为候选范围,把源码邻近的 JSDoc 作为公开参考材料的权威来源,Markdown 页面只作为其忠实编辑投影;本次仅覆盖首轮文档编写。

主要能力:识别包的导出映射与公开 barrel,对候选导出分类为受支持、内部、仅为兼容、已弃用、待定或意外/不清晰;为每个范围内符号定位声明、实现、测试与示例,区分作者输入形状与解析后形状;审计并重写 JSDoc,补充默认值、约束、生命周期、错误、弃用与替代项;将审计后的 JSDoc 投影为简洁 Markdown(轻量分组、接近零叙述)。

使用方式:逐页处理,每页先读现有 Markdown、导航条目、可能承载叙述的邻近指南与相关包的 export map,确定导入路径或配置根(如 @flue/runtime、@flue/runtime/routing、@flue/runtime/node、@flue/runtime/cloudflare、@flue/cli/config)。所有公开声明须对照实现、测试和示例核实;参考文字应贴近其记录的声明,不另建重复声明文件。编辑后构建产出声明的包,检查生成的 .d.ts/.d.mts,并运行相关类型检查与文档构建。

适用场景:编写 Vite 配置参考风格的查询型页面,帮助读者回答可导入或配置什么、TypeScript 签名或字段类型、作用、默认值、约束与生命周期、弃用信息等;将宽泛概念、端到端流程、部署设置与扩展示例移入指南。

限制:不设计生成器、清单、CI 检查或自动维护流程(除非用户明确要求);不自动扩大范围,发现语义模糊、缺陷或限制时应询问是修复、按现状记录还是记录 TODO 并推迟;不把实现怪癖写成公开契约;不把内部、仅为兼容或待定导出呈现为受支持 API;TypeScript 已表达的类型不在 JSDoc 重复。Flue 边界:Runs 仅限工作流,直接 agent 提示与派发输入不算 run;agent 有 name、实例有 id,harness 与 session 有 name,operation 有生成 id;@flue/runtime/internal 属生成服务器管道,非受支持用户 API;兼容子路径不应作为普通受支持面呈现;@flue/cli/config 需区分 UserFlueConfig 等作者配置与 FlueConfig 等解析后内部形状。