SuperAPI AI 工具集

reference-builder

通用与其它

查看项目

更新于 10-16 01:11

技能介绍

用途:该技能面向技术参考文档编写,用于生成完整的 API 参考、配置指南和可检索的参考内容,作为系统的权威信息源。适用于需要编写参数清单、配置说明、Schema 文档或迁移指南的任务;与参考文档无关的任务不适用。

主要能力:完整覆盖每个参数、方法与配置项;按类别精确组织信息便于检索;交叉引用相关概念与依赖;为每个功能提供示例;记录边界情况,包括限制、约束与特殊场景。支持的参考类型包括 API 参考(方法签名、参数、返回类型与取值、错误码与异常、速率限制与性能特征、认证要求)、配置指南(可配置参数、默认值与范围、环境设置、设置间依赖、废弃项迁移路径)以及 Schema 文档(字段类型与约束、校验规则、关系与外键、索引与性能影响、版本演进)。

使用方式:技能定义了条目格式与文档结构,包括类型、默认值、是否必填、引入版本、废弃版本、描述、参数、返回值、抛出异常、示例与参见;组织上采用总览、快速参考、详细参考、进阶主题、附录的层级,并配合目录、字母索引与分类分组。构建流程为盘点、提取、增强、校验、组织、交叉引用。输出以 Markdown 为主,可附 JSON Schema、OpenAPI 规范与机器可读类型定义。

适用场景:需要为系统、API 或配置创建权威参考文档时使用。

限制:仅当任务明确匹配上述范围时使用;输出不能替代针对具体环境的验证、测试或专家评审;缺少必要输入、权限、安全边界或成功标准时应停止并请求澄清。具体安装命令、定价与平台信息暂未提供。