コードベースウォークスルー用のCodeTour .tourファイルを作成し、実際のファイルとラインの範囲に直接開きます。ツアーは.tours/にあり、アドホックなMarkdownノートではなくCodeTour形式を対象としています。
良いツアーは特定の読者への物語:
.tour JSONファイルのみを作成。このスキルの一部としてソースコードを変更しないでください。
次の場合にこのスキルを使用:
| コードツアーの代わりに | 使用 |
|---|---|
| 一度限りの説明で十分 | 直接答える |
ユーザーがプロのドキュメント、.tourアーティファクトではなく |
ドキュメント編集 |
| タスクは実装またはリファクタリング | 実装作業を行う |
| 広範なコードベースオンボーディング | codebase-onboarding |
何か書く前にリポを探索:
コードの形状を理解する前にステップを書き始めないでください。
要求からペルソナと深さを決定。
| リクエストの形 | ペルソナ | 推奨される深さ |
|---|---|---|
| 「オンボーディング」「新しい参加者」 | new-joiner |
9-13ステップ |
Code Tour .tourファイルはJSON形式で、各ステップはファイルパス、ライン番号、説明を含みます。