agentsclimarketplace

Code tour

Skill mturac/everything-openai-codex/docs/ja-JP/skills/code-tour

CodeTour `.tour`ファイルを作成 — ペルソナターゲット、ステップバイステップウォークスルー(実際のファイルとラインアンカー付き)。オンボーディングツアー、アーキテクチャウォークスルー、PRツアー、RCAツアー、構造化「これがどのように機能するかを説明」リクエストに使用。From its SKILL.md

Install
npx -y skills add mturac/everything-openai-codex --skill code-tour

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

SKILL.md

2.7 KB, 816 tokens by cl100k_base, as published. Nobody here has run it

コードツアー

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

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

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

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

使用時期

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

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

使用しないとき

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

ワークフロー

1. 発見

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

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

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

2. 読者を推測

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

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

ツアー形式

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

What ships with it

Read from the repository

Just SKILL.md. No reference files, no scripts.

Keep looking

Skills are one crate of 325,949. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.