代码导览
创建 CodeTour .tour 文件,用于代码库导览,可直接打开真实文件并定位到指定行范围。导览文件存放在 .tours/ 目录中,专为 CodeTour 格式设计,而非临时性的 Markdown 笔记。
一个好的导览应针对特定读者讲述一个故事:
- 他们正在查看什么
- 为什么重要
- 接下来应该遵循什么路径
仅创建 .tour JSON 文件。不要在此技能范围内修改源代码。
何时使用
在以下情况下使用此技能:
- 用户请求代码导览、入职导览、架构导览或 PR 导览
- 用户说“解释 X 如何工作”,并希望获得可重用的引导式产物
- 用户希望为新工程师或审阅者提供上手路径
- 相比平铺直叙的摘要,引导式序列更适合该任务
示例:
- 新维护者入职
- 单个服务或包的架构导览
- 锚定到变更文件的 PR 审查导览
- 展示故障路径的根本原因分析导览
- 信任边界和关键检查的安全审查导览
何时不使用
| 不使用代码导览的情况 | 使用 |
|---|---|
| 在聊天中一次性解释就足够了 | 直接回答 |
用户想要散文式文档,而不是 .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. 读取并验证锚点
每个文件路径和行锚点必须是真实的:
- 确认文件存在
- 确认行号在范围内
- 如果使用选区,验证确…