跳转至

代码导览

为代码库走查创建 CodeTour .tour 文件,并直接打开实际文件和行范围。导览位于 .tours/ 中,面向 CodeTour 格式,而不是临时 Markdown 笔记。

好的导览是面向特定读者的故事: - 他们正在看什么 - 为什么它很重要 - 接下来应该遵循哪条路径

仅创建 .tour JSON 文件。不要作为此技能的一部分修改源代码。

使用时机

在以下情况下使用此技能: - 用户请求代码导览、入职导览、架构走查或 PR 导览 - 用户说“解释 X 如何工作”,并希望获得可复用的引导式工件 - 为新工程师或审阅者提供上手路径 - 任务更适合引导式序列,而不是扁平概述

不使用时机

代码导览的替代 使用
一次性解释就足够 直接回答
用户需要的是专业文档,而不是 .tour 工件 编辑文档
任务是实现或重构 执行实现工作
广泛的代码库入职 codebase-onboarding

工作流

1. 发现

在写任何内容之前探索仓库: - README 和包/应用入口点 - 文件夹结构 - 相关配置文件 - 如果导览聚焦 PR,则查看已修改的文件

在理解代码形状之前,不要开始编写步骤。

2. 推测读者

根据请求确定人物画像和深度。

请求形式 人物画像 推荐深度
“入职”“新成员” new-joiner 9-13 个步骤

导览格式

Code Tour .tour 文件为 JSON 格式,每个步骤包含文件路径、行号和说明。

本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 ev/ECC