Code Tour
创建CodeTour .tour 文件，用于直接打开到真实文件和行范围的代码库导览。导览文件存放在 .tours/ 中，专为 CodeTour 格式设计，而非临时的 Markdown 笔记。
一个好的导览是为特定读者讲述一个故事：
- 他们正在看什么
- 为什么它重要
- 接下来应该走哪条路径
只创建 .tour JSON 文件。不要作为此技能的一部分修改源代码。
何时使用
在以下情况下使用此技能：
- 用户要求提供代码导览、入职导览、架构讲解或 PR 导览
- 用户说“解释 X 是如何工作的”并希望获得一个可重用的引导式产物
- 用户想要为新工程师或审查者提供快速上手路径
- 与简单的摘要相比，引导式序列更适合当前任务
示例：
- 引导新维护者入职
- 一个服务或包的架构导览
- 锚定到变更文件的 PR 审查导览
- 展示故障路径的故障分析导览
- 安全审查导览，展示信任边界和关键检查
何时不使用
| 不要使用 code-tour 的情况 | 应使用 |
|---|---|
| 在聊天中一次性解释就足够了 | 直接回答 |
用户想要散文式文档，而不是 .tour 产物 | documentation-lookup 或仓库文档编辑 |
| 任务是实现或重构 | 执行实现工作 |
| 任务是无需导览产物的广泛代码库入职 | codebase-onboarding |
工作流程
1. 发现
在编写任何内容之前先探索仓库：
- README 和包/应用入口点
- 文件夹结构
- 相关的配置文件
- 如果导览是 PR 导向的，则查看变更的文件
在理解代码结构之前，不要开始编写步骤。
2. 推断读者
根据请求决定角色和深度。
| 请求形态 | 角色 | 建议步骤数 |
|---|---|---|
| “入职”，“新成员” | new-joiner | 9-13 步 |
| “快速导览”，“氛围检查” | vibecoder | 5-8 步 |
| “架构” | architect | 14-18 步 |
| “导览这个 PR” | pr-reviewer | 7-11 步 |
| “为什么坏了” | rca-investigator | 7-11 步 |
| “安全审查” | security-reviewer | 7-11 步 |
| “解释这个功能如何工作” | feature-explainer | 7-11 步 |
| “调试这条路径” | bug-fixer | 7-11 步 |
3. 阅读并验证锚点
每个文件路径和行锚点必须是真实的：
- 确认文件存在
- 确认行号在范围内
- 如果使用选择，验证准确的代码块
- 如果文件不稳定，优先使用基于模式的锚点
永远不要猜测行号。
4. 编写 .tour 文件
写入：
.tours/<角色>-<焦点>.tour
保持路径确定性和可读性。
5. 验证
在完成之前：
- 每个引用的路径都存在
- 每行或每个选择都是有效的
- 第一步锚定到一个真实文件或目录
ref指向的分支或提交确实包含导览引用的每个文件（见下文）- 导览讲述一个连贯的故事，而非简单地列出文件
ref 字段
ref 将导览绑定到一个 git 分支或提交。它比看起来更重要：当 ref 不是读者检出的分支时，CodeTour 从该修订版本（而非磁盘上的文件）打开每个步骤的文件。如果该修订版本中不存在某个文件，该步骤将无法打开——读者会看到 “无法打开编辑器，因为未找到文件”，即使文件就在那里。导览及其注释仍然会显示，因此真实原因很容易被忽略。
根据导览类型选择 ref：
| 导览类型 | 将 ref 设置为 |
|---|---|
| PR 导览 | PR 分支——永远不要设为基础分支 |
| 入职 / 架构 | 读者将检出的分支（通常是 main），或留空 |
| 不确定 | 留空 ref，这样 CodeTour 直接从磁盘读取文件 |
PR 情况是常见的陷阱：PR 通常会添加新文件，而这些文件在基础分支上还不存在。如果将 ref 指向基础分支（例如 develop），则每个在新文件上的步骤都无法打开。
在完成之前，确认每个步骤的文件确实存在于你选择的 ref 中。
步骤类型
仅内容
谨慎使用，通常仅用于结尾步骤：
{ "title": "下一步", "description": "现在您可以端到端地追踪请求路径。" }
不要让第一步成为仅内容步骤。
目录
用于引导读者了解模块：
{ "directory": "src/services", "title": "服务层", "description": "核心编排逻辑在此处。" }
文件 + 行
这是默认的步骤类型：
{ "file": "src/auth/middleware.ts", "line": 42, "title": "认证关口", "description": "每个受保护的请求首先经过此处。" }
选择
当某个代码块比整个文件更重要时使用：
{
"file": "src/core/pipeline.ts",
"selection": {
"start": { "line": 15, "character": 0 },
"end": { "line": 34, "character": 0 }
},
"title": "请求管道",
"description": "此代码块连接了验证、认证和下游执行。"
}
模式
当精确行号可能漂移时使用：
{ "file": "src/app.ts", "pattern": "export default class App", "title": "应用入口" }
URI
在有益的情况下用于 PR、问题或文档：
{ "uri": "https://github.com/org/repo/pull/456", "title": "该 PR" }
编写规则：SMIG
每个描述应回答：
- 情境：读者正在看什么
- 机制：它是如何工作的
- 影响：为什么对这个角色重要
- 陷阱：聪明的读者可能会错过什么
保持描述简洁、具体，并基于实际代码。
叙事结构
除非任务明确需要不同的结构，否则使用以下弧线：
- 导向
- 模块地图
- 核心执行路径
- 边界情况或陷阱
- 结尾 / 下一步行动
导览应该感觉像一条路径，而不是一个清单。
示例
{
"$schema": "https://aka.ms/codetour-schema",
"title": "API 服务导览",
"description": "支付服务请求路径的讲解。",
"ref": "main",
"steps": [
{
"directory": "src",
"title": "源代码根目录",
"description": "服务的所有运行时代码都从这里开始。"
},
{
"file": "src/server.ts",
"line": 12,
"title": "入口点",
"description": "服务器在此启动，并在到达任何路由之前连接中间件。"
},
{
"file": "src/routes/payments.ts",
"line": 8,
"title": "支付路由",
"description": "每个支付请求在进入服务逻辑之前，首先通过此路由器。"
},
{
"title": "下一步",
"description": "现在您可以在主要锚点就位的情况下，端到端地追踪任何支付请求。"
}
]
}
反模式
| 反模式 | 修复方案 |
|---|---|
| 扁平的文件列表 | 讲述一个步骤之间有依赖关系的故事 |
| 泛泛的描述 | 指出具体的代码路径或模式 |
| 猜测的锚点 | 首先验证每个文件和行 |
| 快速导览的步骤过多 | 大胆删减 |
| 第一步是仅内容 | 将第一步锚定到真实文件或目录 |
| 角色不匹配 | 为实际读者编写，而不是泛泛的工程师 |
最佳实践
- 保持步骤数与仓库大小和角色深度成比例
- 使用目录步骤进行导向，使用文件步骤展示实质内容
- 对于 PR 导览，首先覆盖变更的文件
- 对于 monorepo，将范围限定到相关包而不是导览所有内容
- 以读者现在可以做什么来结尾，而不是总结
相关技能
codebase-onboardingcoding-standardscouncil- 官方上游格式：
microsoft/codetour