explaining-codebases skill
✓ 検証済みアーキテクチャマップ、データフロー図、注釈付きのコードウォークスルーを含む、コードベース向けのインタラクティブな解説資料を生成します。
- GitHubスター
- 22
- ファイル
- 4
- 最終コミット
- 2026年10月26日
- ライセンス
- MIT
- 許可されたツール
- —
explaining-codebases skillは何をしますか
アーキテクチャマップ、データフロー図、注釈付きのコードウォークスルーを含む、コードベース向けのインタラクティブな解説資料を生成します。
skillのSKILL.mdから生成された要約。
explaining-codebases skill について
新しいコントリビューターのオンボーディングや、複雑なリポジトリの理解が必要な開発者は、このSKILLを使用してインタラクティブなドキュメントを生成できます。実際のソースファイル、サービス、またはリポジトリを、アーキテクチャマップ、データフロー図、注釈付きのコードウォークスルーを含む自己完結型のインタラクティブな解説資料へと変換します。ユーザーがアーキテクチャの可視化や、コードベース内の特定のメカニズムの動作について尋ねた場合、エージェントはこのSKILLをロードする必要があります。
このプロセスは、実際のコードをナビゲートして、エントリポイント、モジュール構造、および機能の骨組みとなるコンセプトを特定することに基づいています。実行トレースのステッパーや、アイテムが異なるステージをどのように移動するかを示すシーケンス図など、精度の高いアウトプットを生成します。正確性を確保するため、このSKILLではfact-checking-explainersを実行し、引用されたすべてのスニペットと機能に関する主張が、特定のパスと行における実装と一致することを確認する必要があります。最終的なHTMLテンプレート、文章、仕上げの処理については、creating-explainersと連携して動作します。
エージェントができること
- 1新しいチームメンバーのオンボーディング新しいプロジェクトにおいて、モジュールや主要な抽象化がどのように組み合わさっているかを示すアーキテクチャの概要を作成します。
- 2特定のアルゴリズムの深掘り状態の変化やハイライトされた行とともに、単一のアルゴリズムを追跡できる実行トレースステッパーを生成します。
- 3データ移動の可視化リクエストやメッセージがシステムのさまざまなステージをどのように通過するかを示すシーケンス図を作成します。
- 4コードドキュメントの正確性の検証解説資料内のすべてのコードスニペットと機能に関する主張が、現在の実装と一致していることを確認します。
skill の SKILL.md から作成されています。すべてのユースケースは、その引用と照合されています。
explaining-codebases skillのインストール方法
各コマンドはskillフォルダをクライアントのskillsディレクトリにコピーします。読み込むには、クライアントを再起動するか新しいセッションを開始してください。プラグインにexplaining-codebases skillをインストールする
/plugin marketplace add analyticalmonk/explain-this /plugin install explain-this@explain-this
Claude Codeにexplaining-codebases skillをインストールする
~/.claude/skills/explaining-codebases/SKILL.md
$ npx degit analyticalmonk/explain-this/skills/explaining-codebases ~/.claude/skills/explaining-codebasesClaude Code (project)にexplaining-codebases skillをインストールする
.claude/skills/explaining-codebases/SKILL.md
$ npx degit analyticalmonk/explain-this/skills/explaining-codebases .claude/skills/explaining-codebasesCodexにexplaining-codebases skillをインストールする
~/.agents/skills/explaining-codebases/SKILL.md
$ npx degit analyticalmonk/explain-this/skills/explaining-codebases ~/.agents/skills/explaining-codebasesGemini CLIにexplaining-codebases skillをインストールする
~/.gemini/skills/explaining-codebases/SKILL.md
$ npx degit analyticalmonk/explain-this/skills/explaining-codebases ~/.gemini/skills/explaining-codebasesClaude.aiにexplaining-codebases skillをインストールする
npx degit analyticalmonk/explain-this/skills/explaining-codebases explaining-codebases && zip -r explaining-codebases.zip explaining-codebases # claude.ai → Customize → Skills → + → Create skill → Upload a skill → explaining-codebases.zip
自動チェック
実行日 2026年11月15日完全なレポート →自動チェックに合格しました。これはセキュリティ監査ではありません。エージェントに実行させる前にスクリプトを読んでください。 チェックの仕組み
- ソースリポジトリがリンクされており、アクセス可能analyticalmonk/explain-this/skills/explaining-codebases is public and reachablegithub.com/analyticalmonk/explain-this/tree/HEAD/skills/expl ↗合格
- オープンソースライセンス (OSI)MITspdx.org/licenses/MIT.html ↗合格
- 過去1年以内にコミットまたはリリースありLast commit 2026-10-26github.com/analyticalmonk/explain-this/commits ↗合格
- スクリプトにダウンロード実行や認証情報の窃取がないNo scripts in the skill folder合格
- SKILL.md に隠れた指示がないNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/analyticalmonk/explain-this/blob/HEAD/skills/expl ↗合格
- 事前許可ツールが限定されているNo pre-approved tools; the agent asks before using onegithub.com/analyticalmonk/explain-this/blob/HEAD/skills/expl ↗合格
- SKILL.md が Agent Skills の形式に従っているValid name and description; says when to use it; 69 linesgithub.com/analyticalmonk/explain-this/blob/HEAD/skills/expl ↗合格
SKILL.md
GitHubで表示Explaining Codebases
Overview
This skill explains code as it actually exists - a repository, a service, or a set of source files. The output is the same distill-style, single self-contained interactive explainer that creating-explainers produces. What differs is the intake (navigating real code instead of reading a paper) and the figure types (architecture diagrams, data-flow, execution traces, annotated code walkthroughs). It handles both onboarding overviews of a whole codebase and deep-dives on one mechanism.
Required Background
REQUIRED: Use creating-explainers for everything about the output - the HTML template, voice and style, base figure archetypes, color palettes, the outline/scaffold/prose/polish workflow, and the quality checklist. This skill only adds what is specific to code. Do not duplicate that material here.
When to Use
Use when the subject is code:
- Architecture / onboarding overview - how a project is structured: its modules, how data flows between them, the key abstractions, how the pieces fit. For a new contributor who needs the map.
- Single-mechanism deep-dive - how one algorithm, feature, or subsystem works, traced through the real implementation.
The skill picks the angle from the request and confirms it with the user during intake (overview and deep-dive want different figures and different depth).
When NOT to use: a paper, a topic, or any non-code source. Use creating-explainers instead.
Code Intake
See references/code-intake.md. In short: pick the angle, navigate the repository to find entry points and module structure, identify the spine concept (the one path or idea the article tracks), map the architecture, and pull real code snippets anchored to path:line. Quote actual code; never paraphrase code as if quoting it.
Code-Specific Figures
See references/code-figure-archetypes.md for the patterns:
- Architecture / module diagram - modules as boxes, dependencies as arrows
- Data-flow / sequence diagram - an item (request, message, token) moving through stages
- Execution-trace stepper - step through an algorithm with state and the current line highlighted
- Annotated code walkthrough - a code block whose lines reveal annotations as you step or hover
The mechanics (DPR-aware initCanvas, the IIFE pattern, animation loops) come from the base figure-archetypes.md in creating-explainers. The code-figure reference only covers how to apply them to code.
The Fact-Check Gate for Code
REQUIRED before delivery: run fact-checking-explainers. For a codebase explainer the source of truth is the code itself. Every claim about what the code does, and every quoted snippet, is checked against the actual implementation at a specific path and line. Code drifts; a snippet that was accurate yesterday may be wrong today. The interactive explainer is not done until it passes.
Workflow
Same staged workflow as creating-explainers, with code intake in place of the text intakes:
1. Code intake -> navigate, pick angle, find the spine, map architecture, pull real snippets
2. Outline -> propose sections + figure list, get user approval
3. Scaffold -> copy the article template, fill metadata
4. Prose pass -> write all sections with figure placeholders
5. Figures pass -> implement each interactive figure
6. Post-draft fact-check -> verify every claim and snippet against the real code (REQUIRED, blocking)
7. Polish -> run the creating-explainers Quality Checklist to completion
Pause for user approval after the outline. Everything about scaffolding, prose, figures, polish, and the delivery checklist follows creating-explainers.
Common Mistakes
| Mistake | Fix |
|---|---|
| Explaining code that does not exist, or that you imagined | Open the files. Every claim traces to real code at a real path. |
| Snippets drift from the real source | Quote exactly, with path:line. Never tidy code into something the repo does not contain. |
| Architecture diagram does not match the real module structure | Build the diagram from the actual imports and call sites, not a guess. |
| Scope too broad (a whole framework in one article) | Pick one subsystem or one mechanism. Breadth dilutes; depth teaches. |
| Pasting a huge file as a "figure" | Figures illustrate a point the prose just set up. Trim to the lines that matter. |
このスキルのファイル
4explaining-codebases skillに関する質問
Claude Codeにexplaining-codebases skillをインストールするには
npx degit analyticalmonk/explain-this/skills/explaining-codebases ~/.claude/skills/explaining-codebasesを実行してください。Claude Codeは~/.claude/skills(すべてのプロジェクト)または.claude/skills(単一プロジェクト)からskillsを読み込み、説明がタスクに一致する場合にskillを使用します。
explaining-codebases skillはどのクライアントで使用できますか
Agent Skills形式を読み込むすべてのクライアントで使用できます: Claude Code、Codex、Gemini CLI、claude.ai(ZIPとしてアップロード)。skill内のスクリプトは、クライアントがコード実行を許可した場合にのみ実行されます。
コードの解説の正確性をどのように担保していますか?
このSKILLでは、すべての主張とコードスニペットが、特定のパスと行にある実際のインプリメンテーションと照らし合わせて検証される、必須のファクトチェックステップが含まれています。
このSKILLを使用すべきでないケースはありますか?
論文、一般的なトピック、またはコード以外のソースについては、このSKILLを使用しないでください。代わりにcreating-explainersを使用してください。