SuperAPI AI 工具集

reference-builder

通用与其它

查看项目

更新于 10-16 03:39

技能介绍

用途:为系统、API、配置或数据模式编写可作为权威来源的完整技术参考文档,覆盖每个参数、方法和配置项,并保证可搜索、可交叉引用。\n\n主要能力:全面覆盖(参数、方法、配置项)、精确分类便于检索、交叉引用关联概念与依赖、为每个功能提供示例、记录边界条件与限制;文档类型包括 API 参考(方法签名、返回类型、错误码、速率限制、认证要求)、配置指南(默认值、取值范围、环境相关设置、设置间依赖、弃用迁移路径)、模式文档(字段类型与约束、校验规则、关系与外键、索引与性能影响、版本演进)。\n\n使用方式:按流程先明确目标、约束与所需输入,再进行接口清点、从代码抽取文档、补充示例与上下文、验证准确性与完整性、组织结构和交叉引用。条目采用统一格式,如“### [功能/方法/参数名]”,并标注 Type、Default、Required、Since、Deprecated、Description、Parameters、Returns、Throws、Examples、See Also。内容按概览、快速参考、详细参考、高级主题、附录分层组织,配合目录、字母索引、搜索标记和版本化文档。输出以 Markdown 为主,可附 JSON schema、OpenAPI 规范等机器可读定义。\n\n适用场景:编写 API 文档、配置手册、数据库/数据模式说明、迁移指南和故障排查指南。\n\n限制:官方资料未提供具体安装命令、价格、支持平台或效果数据;该技能仅适用于参考文档构建相关工作,不适用于无关任务。