Code Tour

by affaan-mef648e01899bNo license275K starsListed Oct 8, 2026Updated Oct 8, 2026Repository updated 3 days ago

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

Instructions onlySoftware Development
AI-generated overview

Creates CodeTour .tour JSON files that guide readers through a codebase with file and line anchors.

What it does
Produces CodeTour .tour files, stored under .tours/, that walk a reader through a codebase as a guided sequence of steps. Each step points at a real file path and line range with an explanation of what the reader is seeing and why it matters. It targets specific personas and depths, such as onboarding tours, architecture walkthroughs, PR tours, and RCA tours, and does not modify source code.
When to use it
Use it when someone asks for a code tour, onboarding tour, architecture walkthrough, or PR tour, or wants a reusable guided artifact explaining how something works. It fits ramp-up paths for new engineers or reviewers that are better served by a guided sequence than a flat summary.
Requirements
No scripts or special tooling; it only needs repository access to explore files and write .tour JSON files.

コードツアー

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

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

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

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

使用時期

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

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

使用しないとき

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

ワークフロー

1. 発見

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

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

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

2. 読者を推測

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

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

ツアー形式

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

Source and attribution

Source:affaan-m/eccindocs/ja-JP/skills/code-tourat commitef648e0

License: No license

Content belongs to its original authors. SourceWeft indexes it from a public repository.

Report or request removal