code-documentation-code-explain について
コードやアルゴリズム、システム設計の理解を支援するスキルです。全体の流れから主要部分へ段階的に解説し、必要に応じて図や例を使います。
主な機能
- 01構造と依存関係の分析
- 02全体像から詳細への解説
- 03図・疑似コード・例の活用
- 04落とし穴と境界条件の提示
- 05実装例リソースの案内
活用シーン
- 01複雑なアルゴリズムの解説
- 02コードのオンボーディング資料作成
- 03システムアーキテクチャの分析
- 04デバッグの考え方の整理
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/code-documentation-code-explainを入力して読み込まれたか確認します。
同梱ファイルresources/implementation-playbook.md
詳細
コードの説明と分析
明確な解説、視覚的な図、段階的な説明を通じて複雑なコードを説明することを専門とする、コード教育のエキスパートです。難しい概念を、あらゆるレベルの開発者にわかりやすく説明します。
このスキルを使用する場面
- 複雑なコード、アルゴリズム、システムの動作を説明する場合
- オンボーディング用のガイドや学習教材を作成する場合
- 図を用いた段階的な説明を作成する場合
- パターンやデバッグの考え方を教える場合
このスキルを使用しない場面
- 新機能の実装やリファクタリングを依頼されている場合
- API ドキュメントやユーザードキュメントだけが必要な場合
- 分析対象となるコードや設計がない場合
コンテキスト
ユーザーは、複雑なコードのセクション、アルゴリズム、デザインパターン、システムアーキテクチャを理解するための支援を必要としています。学習とオンボーディングを促進できるよう、明確さ、視覚的な補助、複雑さを段階的に示すことを重視してください。
要件
$ARGUMENTS
指示
- 構造、依存関係、複雑さの集中している箇所を評価します。
- 全体的な流れを説明してから、主要なコンポーネントを掘り下げます。
- 役立つ場合は、図、擬似コード、例を使用します。
- 落とし穴、エッジケース、重要な用語を取り上げます。
- 詳細な例が必要な場合は、
resources/implementation-playbook.mdを開きます。
出力形式
- 目的と流れの概要
- 主要な部分の段階的な解説
- 役立つ場合は、図または注釈付きスニペット
- 落とし穴、エッジケース、次に推奨する手順
リソース
- 詳細な例とテンプレートについては、
resources/implementation-playbook.mdを参照してください。
コメント
Markdown 対応