SKILL

code-tour

创建 CodeTour `.tour` 文件——针对特定角色的、带有真实文件和行锚点的逐步演练。用于入职引导、架构演练、PR 演练、RCA 演练以及结构化的“解释其工作原理”请求。

适用对象:软件开发与测试。自动收录 · 待核查。

原作者说明节选

从固定版本的 SKILL.md 提取,保留原文语言。以下内容属于作者说明,本站尚未验证安装、兼容或运行结果。

查看中文原文

原文涵盖的主题

  • 代码导览
  • 何时使用
  • 何时不使用
  • 工作流程
  • 1. 探索
  • 2. 推断读者
  • 3. 读取并验证锚点
  • 4. 编写 .tour

创建 CodeTour .tour 文件,用于代码库导览,可直接打开真实文件并定位到指定行范围。导览文件存放在 .tours/ 目录中,专为 CodeTour 格式设计,而非临时性的 Markdown 笔记。 一个好的导览应针对特定读者讲述一个故事: 他们正在查看什么 为什么重要 接下来应该遵循什么路径 仅创建 .tour JSON 文件。不要在此技能范围内修改源代码。 在以下情况下使用此技能: 用户请求代码导览、入职导览、架构导览或 PR 导览 用户说“解释 X 如何工作”,并希望获得可重用的引导式产物 用户希望为新工程师或审阅者提供上手路径 相比平铺直叙的摘要,引导式序列更适合该任务 示例: 新维护者入职 单个服务或包的架构导览 锚定到变更文件的 PR 审查导览 展示故障路径的根本原因分析导览 信任边界和关键检查的安全审查导览 | 不使用代码导览的情况 | 使用 | | --- | --- | | 在聊天中一次性解释就足够了 | 直接回答 | | 用户想要散文式文档,而不是 .tour 产物 | documentation-lookup 或仓库文档编辑 | | 任务是实现或重构 | 执行实现工作 | | 任务是没有导览产物的广泛代码库入职 | codebase-onboarding | 在编写任何内容之前探索仓库: README 和包/应用入口点 文件夹结构 相关配置文件 如果导览聚焦于 PR,则查看变更的文件 在理解代码结构之前,不要开始编写步骤。 根据请求确定角色和深度。 | 请求形式 | 角色 | 建议深度 | | --- | --- | --- | | "入职","新成员" | 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 步 | 每个文件路径和行锚点必须是真实的: 确认文件存在 确认行号在范围内 如果使用选区,验证确切的代码块 如果文件易变,优先使用基于模式的锚点 切勿猜测行号。 写入: 保持路径确定且可读。 在完成之前: 每个引用的路径都存在 每行或每个选区都有效 第一步锚定到真实文件或目录 导览讲述连贯的故事,而非罗列文件 谨慎使用,通常仅用于结束步骤: 不要将第一步设为纯内容。 用于引导读者了解模块: 这是默认步骤类型: 当某

这里只展示节选,请以完整原文和当前要求为准。

来源仓库
affaan-m/ECC
源文件
docs/zh-CN/skills/code-tour/SKILL.md
固定版本
d2ef2680594f9a17526a6e1a2e18b3d242c5d17b
阅读完整原作者说明 ↗

准备条件

  • 本条仅收录原作者的技能元数据;请阅读完整说明,确认依赖、许可与使用条件。

第一件可以尝试的小事

先阅读原作者说明,再决定是否在自己的 AI 工具中使用。

对应 AI 工具说明

作者有说明不等于本站实机验证。没有证据时,不自动标为兼容、安全或免费。

来源与内容状态

本条为自动发现的元数据,尚未完成人工文档核查;适用性与运行结果待核查。

原作者:affaan-m/ECC · 原作者仓库元数据。文档核查:未核查。最近来源检查:2026-11-09T14:01:50.211Z。

分类由名称、说明与路径规则生成,分类不代表已核实适配。

许可与权利归属

MIT。第三方内容及版权归原作者,使用条件以原文为准。

许可原文 ↗

本站没有因同步、复制或用户自报成功而将资源标为运行验证通过。

限制与注意事项

  • 元数据收录不代表本站已经安装、适配、实测或进行安全审查。