Code Tour

作者 affaan-mef648e01899b无许可证275K 个星标收录于 2026年10月8日更新于 2026年10月8日仓库3天前更新

CodeTour `.tour`ファイルを作成 — ペルソナターゲット、ステップバイステップウォークスルー(実際のファイルとラインアンカー付き)。オンボーディングツアー、アーキテクチャウォークスルー、PRツアー、RCAツアー、構造化「これがどのように機能するかを説明」リクエストに使用。

AI 生成的概览

创建 CodeTour .tour JSON 文件,通过文件与行锚点引导读者浏览代码库。

功能
生成存放在 .tours/ 下的 CodeTour .tour 文件,以分步引导的方式带读者浏览代码库。每个步骤指向真实的文件路径和行范围,并说明读者看到的内容及其重要性。它面向特定读者和深度,例如入门导览、架构讲解、PR 导览和 RCA 导览,且不会修改源代码。
适用场景
当有人要求代码导览、入门导览、架构讲解或 PR 导览,或希望获得可复用的引导式说明来解释某功能如何运作时使用。它适合新工程师或评审者的上手路径,这类场景用引导式顺序比平铺式摘要更有效。
运行要求
无需脚本或特殊工具;只需访问代码库以浏览文件并写入 .tour JSON 文件。

コードツアー

コードベースウォークスルー用のCodeTour .tourファイルを作成し、実際のファイルとラインの範囲に直接開きます。ツアーは.tours/にあり、アドホックなMarkdownノートではなくCodeTour形式を対象としています。

良いツアーは特定の読者への物語:

  • 彼らが何を見ているか
  • なぜそれが重要か
  • 次にどのパスを従うべきか

.tour JSONファイルのみを作成。このスキルの一部としてソースコードを変更しないでください。

使用時期

次の場合にこのスキルを使用:

  • ユーザーがコードツアー、オンボーディングツアー、アーキテクチャウォークスルー、またはPRツアーを求める
  • ユーザーが「Xがどのように機能するかを説明」と言い、再利用可能なガイド付きアーティファクトを望む
  • 新しいエンジニアまたはレビュアーのためのランプアップパス
  • タスクはフラット概要ではなくガイド付きシーケンスでより良くサービスされる

使用しないとき

コードツアーの代わりに使用
一度限りの説明で十分直接答える
ユーザーがプロのドキュメント、.tourアーティファクトではなくドキュメント編集
タスクは実装またはリファクタリング実装作業を行う
広範なコードベースオンボーディングcodebase-onboarding

ワークフロー

1. 発見

何か書く前にリポを探索:

  • READMEとパッケージ/アプリエントリポイント
  • フォルダ構造
  • 関連するコンフィグファイル
  • ツアーがPRフォーカスの場合は変更されたファイル

コードの形状を理解する前にステップを書き始めないでください。

2. 読者を推測

要求からペルソナと深さを決定。

リクエストの形ペルソナ推奨される深さ
「オンボーディング」「新しい参加者」new-joiner9-13ステップ

ツアー形式

Code Tour .tourファイルはJSON形式で、各ステップはファイルパス、ライン番号、説明を含みます。

来源与署名

来源:affaan-m/ecc位于docs/ja-JP/skills/code-tour提交ef648e0

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架