代码导览
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3c6cb52e/code-tour 到 AI 助手中。
技能介绍
解决什么问题
团队中的代码库往往缺乏一份"会说话的文档"。新成员拿到仓库后,常需要花半天甚至更长时间才能理清入口在哪、核心模块怎么流转;PR 评审者面对一堆改动,很难快速判断风险点分布在哪里;故障排查时,因果链散落在多个文件里,靠人脑记忆容易遗漏关键环节。传统 README 或架构文档又容易与实际代码脱节,时间一长就失去参考价值。
code-tour 技能针对的就是这一痛点:它不写普通文档,而是生成可直接在 VS Code 中运行的 CodeTour 导览文件,把"看哪里、为什么重要、下一步做什么"串成一条叙事线,锚点精确到文件和行号。
技能如何工作
技能的核心流程分为四步:
- 探索仓库 —— 并行执行根目录列表、README 阅读、配置文件检查,识别语言、框架和项目用途,映射 1-2 层目录结构,找到入口点。
- 推断意图 —— 根据用户表述自动判断 persona 和深度,无需反复追问。
- 读取实际文件 —— 每个文件路径和行号都必须经过实际阅读验证,绝不猜测。
- 写入导览 —— 保存为
.tours/xxx.tour文件,支持六种步骤类型:Content(内容页)、Directory(目录定位)、File + line(文件行号锚点)、Selection(代码块高亮)、Pattern(正则匹配,适用于易变文件)、URI(外链 PR、issue 或文档)。
导览的步骤数按深度分档:Quick 5-8 步、Standard 9-13 步、Deep 14-18 步。每条步骤描述遵循 SMIG 公式:Situation(读者在看什么)、Mechanism(代码怎么运作)、Implication(对当前 persona 为何重要)、Gotcha(容易踩的坑)。
技能内置十种 persona,覆盖新成员、PR 评审者、RCA 调查者、架构师、安全审查者等场景,每种 persona 都定义了必须覆盖的内容和目标。
适用边界与注意点
- 技能只生成
.tour文件,绝不修改源代码。 - 文件路径必须相对于仓库根目录,不能以
/或./开头。 - 如果仓库源码文件少于 5 个,直接创建 quick 深度导览,不必强行拉长。
- 第一步必须锚定到文件或目录,纯内容页会导致 VS Code 中显示空白。
- 内容页最多 2 个,分别用于开头和结尾。
- 避免把导览写成文件列表或复述式结尾,每条步骤都应该推进叙事,结尾告诉读者"现在能做什么"。
使用场景
- 新成员入职第一天,需要在半天内弄清仓库入口、核心模块和主要业务逻辑,而不是逐个文件翻看
- 评审一个包含多文件改动的 PR 时,需要快速定位改动故事、关键不变式和高风险区域
- 线上服务出现故障后做 RCA,需要沿着因果链把触发点、故障传播路径和可观测锚点串成一条线
- 为新功能编写架构说明时,需要从 UI 到 API 再到后端存储画出端到端的调用路径
适合人员
- 刚入职的后端工程师,需要在最短时间内理解代码结构并开始参与开发
- 负责合并 PR 的技术负责人,需要在评审前快速把握改动的影响范围与风险点
- 参与事故复盘的 SRE 或后端工程师,需要沿调用链定位故障根因并给出说明
- 维护开源项目的维护者,需要为外部贡献者写一份安全的上手导览,标明禁区和惯例