SuperAPI AI 工具集

code-walkthrough

编程与开发

查看项目

更新于 10-24 16:19

技能介绍

用途

code-walkthrough 用于在开发者面对不熟悉的代码库时,提供逐步的引导式讲解。它针对一个目标(文件、目录或 PR)生成一份交互式讲解产物(artifact),帮助第一次接触该代码的人理解代码做什么、各部分如何组合,以及为什么这样构建。

主要能力

  • 生成自包含的 HTML 讲解页面,读者可从头到尾阅读。
  • 页面结构包括:一段话摘要、结构地图(主要组成部分及其连接关系)、讲解区块、开放问题。
  • 讲解区块使用可展开的 <details> 块,每个对应地图中的一个部分。
  • 每个区块内包含:该部分的通俗解释、带注释的真实代码片段(裁剪到相关行,对不明显的部分做行内说明)、以及“为什么重要”提示(说明如果该部分不存在或行为不同会有什么后果)。
  • 页面正文末尾包含一行固定文字,提示读者可将 URL 粘贴回 Claude Code 继续迭代。

使用方式

技能描述中说明:如果没有给出目标,会先向用户提一个简短问题,询问想讲解哪个文件、目录或 PR,然后等待回答。确定目标后,先阅读目标及其直接依赖(调用方、被调用方、涉及的类型、相关测试),建立心智模型后再撰写产物。撰写时先加载 artifact-design 技能,页面采用实用风格(这是文档,不是落地页)。最后用 Artifact 工具发布 HTML 文件。

适用场景

  • 引导开发者理解陌生的代码库。
  • 解释单个文件、一个目录或一个 PR 的变更(before→after)。
  • 面向“假设读者是有能力的工程师但从未见过此代码库”的讲解。

限制

  • 技能描述强调诚实:解释代码实际行为(通过追踪),而非名称暗示的行为;真正简单的部分应简短说明后继续,不要填充内容。
  • 无法从代码中确定的内容应列入开放问题,宁可诚实说“不知道”也不要猜测。
  • 关于收费、价格、平台支持等具体信息,资料中暂未提供。