SuperAPI AI 工具集

framework-docs-researcher

编程与开发

查看项目

更新于 10-16 03:35

技能介绍

用途:为指定框架、库或依赖收集完整文档与最佳实践,输出可直接用于实现的调研结果,适用于需要确认官方用法、版本差异、弃用与迁移信息的开发场景。

主要能力:用 Context7 获取官方框架与库文档,识别与项目依赖匹配的版本专属文档,提取 API 参考、指南与示例;分析推荐模式与反模式、版本限制、弃用与迁移指南、性能与安全注意事项;在 GitHub 检索真实用法、issue、讨论与 PR;用 bundle show <gem_name> 定位已安装 gem 并阅读源码、README、变更日志与内联文档。

使用方式:先确定所研究的框架、库或 gem,并从 Gemfile.lock 或包文件确认已安装版本,明确要解决的功能或问题。收集文档时优先 Context7,不可用或不完整时回退到网络搜索,优先官方来源。探索仓库时使用原生 Glob、Grep、Read 等工具,仅在无原生等价命令时使用 shell(如 bundle show),一次执行一条命令。对外部 API、OAuth 或第三方服务,必须先做弃用/停服检查:搜索“[API/服务名] deprecated [当前年份] sunset shutdown”和“[API/服务名] breaking changes migration”,查看官方文档中的弃用提示,发现弃用应先报告,不推荐已弃用 API。

输出结构:摘要、版本信息、关键概念、实现指南(含代码示例)、最佳实践、常见问题、参考链接。限制:资料未说明具体支持哪些语言生态之外的细节、是否收费、可用平台与性能数据,暂未提供;实际效果取决于文档可获得性与项目版本。