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 從公開儲存庫中收錄這些內容。

檢舉或申請下架