docs/ja-JP/skills/code-tour

stars:0
forks:0
watches:0
last updated:N/A

コードツアー

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

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

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

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

使用時期

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

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

使用しないとき

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

ワークフロー

1. 発見

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

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

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

2. 読者を推測

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

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

ツアー形式

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

    Good AI Tools