外部代码库调研
适用范围
用于第三方库、外部仓库、上游代码的研究,例如:
- •官方文档中的 API 说明
- •GitHub 仓库中的源码实现
- •版本特定的行为和默认值
核心原则
- •事实驱动:没有权威来源支持就不做断言,明确说明缺失的证据
- •证据必需:每个声明都需要文档引用或代码路径+符号+行号
- •版本锚定:优先使用 tag/release > commit SHA > branch;标记版本不确定性
- •灵活选择:根据场景选择合适的工具,无需固定顺序
工具选择
根据需求选择合适的工具:
| 工具 | 用途 | 适用场景 |
|---|---|---|
mcp_io_github_ups_get-library-docs (Context7) | 官方文档查询 | 主流库的概念/用法/API |
mcp_cognitionai_d_ask_question (DeepWiki) | 文档问答 | 需要高信息密度的答案 |
github_repo | 源码阅读 | 需要查看具体实现、默认值、条件逻辑 |
| 网络搜索 | 发现入口 | 定位规范仓库/文档、找到问题切入点 |
说明:
- •概念理解优先用文档工具(Context7/DeepWiki)
- •具体实现细节用源码工具(github_repo)
- •网络搜索仅用于发现,不作为实现真相的依据
执行要点
- •明确目标:库/仓库名 + 问题 + 版本约束
- •选择工具:根据上表按场景选择
- •版本锚定:记录使用的版本信息
- •证据输出:引用文档章节或代码路径
反模式
- •❌ 没有证据就推断
- •❌ 把 issue/博客当作实现真相
- •❌ 阅读大量无关文件
- •❌ 混用不同版本的信息而不标注