SuperAPI AI 工具集

pre-work-research

写作与研究

查看项目

更新于 10-16 03:38

技能介绍

用途:在动手实现之前先做调研,理解代码库与文档现状,避免盲目改动。适用于不熟悉的代码区域、新库或 API、复杂集成、性能敏感或安全敏感代码;简单孤立改动只需极少调研。

主要能力与流程:

  1. 理解需求:读完整 issue 描述、验收标准、约束,找出未知点。
  2. 调研仓库文档:查看 README.md、docs/ 下的架构与设计文档、CONTRIBUTING.md、API 文档,关注架构决策、设计模式、编码规范、测试要求与部署考虑。
  3. 调研现有代码:用 grep 查找相似功能、相关测试与模块导入,阅读 2-3 个相似实现,检查 src/utils/ 中可复用工具与共享 helper。
  4. 调研外部资源:查阅依赖官方文档、API 参考(认证、限流、错误处理、响应格式、版本),以及 GitHub issues、Stack Overflow、博客等社区资源。
  5. 记录发现:输出调研摘要,包含需求理解、代码库模式、外部依赖、实现方案与风险/注意事项。
  6. 必要时更新 issue:用 gh issue comment [ISSUE_NUMBER] --body "..." 评论调研结论、考虑与待澄清问题。

调研深度按任务规模:琐碎任务无需调研;单文件小改动做快速模式检查;中等功能走完整流程;大型系统做扩展调研。快速模式检查约 5 分钟,完整流程约 15-30 分钟,扩展调研 1 小时以上。

输出与集成:调研后应清楚相似功能如何实现、应遵循哪些模式、有哪些可用工具、测试方式及风险。该技能由 issue-driven-development 第 5 步调用,并为 tdd-full-coverage、strict-typing、inline-documentation 提供依据。

限制:资料未提供具体安装方式、收费、平台支持或效果数据;命令示例需按实际项目路径调整。