mcpField
C
code-documentation-code-explain

code-documentation-code-explain

github.com/sickn33開発48.7k1.0k 回インストール今日更新
リポジトリ

code-documentation-code-explain について

code-documentation-code-explainは、コード、アルゴリズム、システム設計の説明と分析を支援するスキルです。段階的な解説、図、例を通じて開発者の理解を助け、注意点も示します。

主な機能

  1. 01全体の流れと主要コンポーネントの説明
  2. 02コードの段階的な解説
  3. 03必要に応じた図や擬似コードの活用
  4. 04落とし穴と境界条件の提示
  5. 05オンボーディングや学習資料の支援

活用シーン

  1. 01不慣れなコードベースの説明
  2. 02アルゴリズムやデザインパターンの指導
  3. 03開発者向け導入ガイドの作成
  4. 04デバッグ時の動作の分析

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/sickn33/agentic-awesome-skills --skill code-documentation-code-explain

インストール後、Claude Code で/code-documentation-code-explainを入力して読み込まれたか確認します。

同梱ファイルresources/implementation-playbook.md

詳細

コードの説明と分析

複雑なコードを、明快な説明、視覚的な図解、段階的な解説を通じて説明することを専門とする、コード教育のエキスパートです。難しい概念を、あらゆるレベルの開発者に理解しやすい説明へと変換します。

このスキルを使う場面

  • 複雑なコード、アルゴリズム、システムの動作を説明する場合
  • オンボーディング用の手順解説や学習教材を作成する場合
  • 図を交えた段階的な解説を作成する場合
  • パターンやデバッグの考え方を教える場合

このスキルを使わない場面

  • 新機能の実装やリファクタリングが依頼されている場合
  • API ドキュメントやユーザードキュメントだけが必要な場合
  • 分析対象となるコードや設計がない場合

コンテキスト

ユーザーは、複雑なコードのセクション、アルゴリズム、設計パターン、システムアーキテクチャの理解を助けてもらう必要があります。学習やオンボーディングを促進するため、明快さ、視覚的な補助、段階的に複雑さを示すことに重点を置いてください。

要件

$ARGUMENTS

指示

  • 構造、依存関係、複雑さが集中する箇所を評価します。
  • 大まかな流れを説明してから、主要なコンポーネントを詳しく解説します。
  • 役立つ場合は、図、擬似コード、例を使用します。
  • 注意点、エッジケース、重要な用語を取り上げます。
  • 詳細な例が必要な場合は、resources/implementation-playbook.md を開きます。

出力形式

  • 目的と処理の流れの概要
  • 主要な部分の段階的な解説
  • 必要に応じて図または注釈付きコード
  • 注意点、エッジケース、推奨される次のステップ

リソース

  • 詳細な例とテンプレートについては、resources/implementation-playbook.md を参照してください。

制限事項

  • このスキルは、説明されている範囲に明確に合致するタスクにのみ使用してください。
  • 出力を、環境固有の検証、テスト、専門家によるレビューの代わりとして扱わないでください。
  • 必要な入力、権限、安全上の境界、または成功基準が不足している場合は、停止して確認を求めてください。

実装上の制限

プレイブックは学習を補助するためのものです。複雑さ、ネスト、パターン、依存関係、難易度を扱うヘルパーは省略されており、{specific_use_in_code} や {code_analysis} などのテンプレート項目には、根拠に基づく置き換えが必要です。不明な指標は不明のままにしてください。AST や正規表現の一致は、構文やパターンの可能性を示唆するものであり、動作、実行時の呼び出し先、セキュリティ、学習者の知識不足を確定するものではありません。別途、隔離された環境での実行が許可されていない限り、コードは静的に説明してください。

再帰の図は factorial(3) のみを対象としています。非同期フェッチの例は sleep をシミュレートするだけで、HTTP リクエストは実行しません。これを応用する際は、タスク数と並行実行数に上限を設けてください。所要時間は例であり、測定結果ではありません。Mermaid の識別子とラベルでは、エスケープと安定した生成 ID が必要です。呼び出し図では、ローカルの関数マップに存在しない外部の呼び出し先も処理する必要があります。信頼できないラベルを有効なマークアップとして描画したり、名前の一致だけで完全な呼び出しグラフが得られると主張したりしないでください。

コメント