SuperAPI AI 工具集

code-walkthrough

编程与开发

查看项目

更新于 10-15 11:00

技能介绍

用途

代码导读(Code Walkthrough)用于帮助开发者快速理解不熟悉的项目或模块,建立"这个系统怎么运转"的心智模型。它的定位不是逐行翻译代码或简单读文件列目录,而是提炼出"这段代码在做什么、为什么这么做、和其他部分怎么连接"。

主要能力

技能按"架构 → 流程 → 细节"三层递进梳理代码:

  • 架构层:回答系统由什么组成,输出模块组成、依赖关系与数据流向。
  • 流程层:回答核心功能怎么运转,选取 1-3 个最核心流程做详细走读,标注关键点。
  • 细节层:回答为什么这么写,梳理关键设计决策、隐含约定与潜在风险。

导读准则包括:不逐行翻译、先宏观后微观、关注模块间连接、标注文件与行号、诚实说明不确定之处、按读者水平调整解释方式。

使用方式

第一步,确定导读范围和深度。通过 AskUserQuestion 确认三项信息:导读目标(整个项目、某个模块还是某个功能)、导读目的(接手维护、准备改动还是纯了解)、已有认知(避免输出用户已知信息)。根据范围选择全局导读、模块导读或流程导读。

第二步,全局扫描。用 2-3 个工具调用建立全局感知:读取项目根目录结构、配置文件(如 package.json、pyproject.toml、tsconfig.json)、README/CLAUDE.md/docs,并检查 git log 最近 20 条提交。提取技术栈、项目类型、目录组织等关键信息,并定位目标区域的入口文件、文件清单与依赖关系。

第三步,分层梳理,按架构层、流程层、细节层依次输出。

第四步,输出导读文档。快速了解可直接在对话中回答;完整导读写入 docs/guides/<模块名>-walkthrough.md,结构包含技术栈、架构概览、核心流程、关键设计决策、隐含约定、注意事项与相关文档。

适用场景

  • 接手新项目,需要建立心智模型。
  • 准备改动代码前,先理解现有结构。
  • 纯了解某个模块或功能逻辑。

与其他技能的关系:接手新项目用 code-walkthrough 建立心智模型,准备改动用 refactoring 做影响分析,改动前评估用 dependency-map。code-walkthrough 关注"是什么、怎么运转、为什么这么写",dependency-map 关注"改这里会动到哪里",通常先 walkthrough 理解,再 dependency-map 评估影响。

限制

资料未提供该技能的具体安装命令、支持的平台、收费方式或价格信息。