Code Tour

コードツアー

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

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

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

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

使用時期

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

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

使用しないとき

ワークフロー

1. 発見

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

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

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

2. 読者を推測

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

ツアー形式

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