技能 编程开发 代码流程游览生成器

代码流程游览生成器

v20260517
code-tour
用于创建结构化的CodeTour `.tour`文件,实现代码库的步进式游览。适用于新员工入职指导、系统架构讲解、代码审查(PR)或分析某个功能的工作流程。它提供精确到文件和行号的指南,确保学习路径清晰且具有目的性。
获取技能
461 次下载
概览

コードツアー

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

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

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

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

使用時期

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

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

使用しないとき

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

ワークフロー

1. 発見

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

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

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

2. 読者を推測

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

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

ツアー形式

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

信息
Category 编程开发
Name code-tour
版本 v20260517
大小 2.69KB
更新时间 2026-05-18
语言