explain
コードをASCII図、類似例、段階的な説明を使って解説します。ユーザーが「これはどう動作しているのか」「このコードを説明して」「手順を教えて」「これは何をするのか」「これを理解するのを手伝って」などと質問した際に使用します。
description の原文を見る
Explain code using ASCII diagrams, analogies, and step-by-step walkthroughs. Use when the user asks "how does this work?", "explain this code", "walk me through this", "what does this do?", or "help me understand this".
SKILL.md 本文
コンテキスト
- 現在のファイルまたはシンボル: $ARGUMENTS
- リポジトリルート: !
git rev-parse --show-toplevel 2>/dev/null || pwd
タスク
$ARGUMENTS で識別されるコード(または引数が指定されていない場合は最近説明したコード)を説明します:
-
関連するソースファイルを完全に読み込みます。インポートと依存関係を1レベル深く追跡して、全体像を理解します。
-
詳細に入る前に、コードが高レベルで何をしているかを特定します。
-
説明を以下のように構成します:
類推
コードを日常生活の何かと比較します。キャッシュはモニターに貼られた付箋紙のようなものです。メッセージキューはレストランのチケットレールのようなものです。最も適切な類推を選んで、2~3文で説明します。
全体像(ASCIIダイアグラム)
構造、データフロー、またはコンポーネント関係を示すASCIIダイアグラムを描画します。方向を示すために矢印(-->、==>)を使用します。30行以下に保ちます。例:
Request --> [Auth Middleware] --> [Router] --> [Handler] --> DB
| |
401 Denied [Cache] --> Redis
ステップバイステップウォークスルー
ファイルの順序ではなく、実行順序でコードをウォークスルーします。重要な各ステップについて:
- 何が起こるか
- なぜそれが起こるか(設計意図)
- 何が間違っている可能性があるか(エッジケースまたは前提条件)
ひっかかりやすいポイント
経験豊富な開発者でさえ誤解する、このコードについてのよくある間違いまたは誤解。具体的に説明します。
重要なファイル
このエリアを理解するための最も重要なファイルを、1行の説明とともにリストアップします。
トーンは会話的に保ちます。短い文を推奨します。用語が定義されていない限り、専門用語を避けます。ターゲットが見つからない場合は、明確にそう述べて、ユーザーが代わりに何を探すかを提案します。
ライセンス: MIT(寛容ライセンスのため全文を引用しています) · 原本リポジトリ
詳細情報
- 作者
- CodeWithBehnam
- ライセンス
- MIT
- 最終更新
- 2026/5/12
Source: https://github.com/CodeWithBehnam/cc-docs / ライセンス: MIT