Communitygithub.com

Adamska1008/explain-with-code

コードに関する会話をソースリファレンスとスニペットで具体化する、静かなエージェントスキルです。

explain-with-code とは?

Explain With Code は、コードベースに関する会話において、抽象的な説明ではなく具体的なソースコードの証拠を示すことを重視したエージェントスキルです。このスキルは、プロジェクトの説明を行う際に、まず関連ファイルを確認し、主要な主張に対してファイルパスと行番号を含む具体的なリファレンスを提供します。重要な振る舞いごとに最小限のコードスニペットを引用または要約し、エントリーポイント、呼び出しフロー、データフロー、状態変化、副作用、境界条件など、コードの各部分がどのように連携しているかを分かりやすく解説します。主にClaude CodeやCursor、Codexなどのコード補完・対話型エージェントでの使用を想定しており、証明できないコードについてはその旨を明示し、推測と検証済みのソース情報を明確に区別することで、開発者に対して信頼性の高い説明を提供します。

対応~Claude Code~Codex CLI~Cursor
npx skills add Adamska1008/explain-with-code

お気に入りのAIに質問する

このエージェントスキルを事前に読み込んだ状態で新しいチャットを開きます。

ドキュメント

Explain With Code (コードで説明する)

プロジェクトを説明するときは、コードを証拠にします。

  1. ユーザーが正確なコードをすでに提供していない限り、説明の前に関連ファイルを確認します。
  2. 主要な主張に対して、ファイル参照と行番号を具体的に記載します。
  3. 重要な振る舞いごとに、最小限の有用なコードスニペットを引用または要約します。ソースに結びつかない漠然とした散文は避けます。
  4. 参照したコードがどのように連携しているかを説明します:エントリーポイント、呼び出しフロー、データフロー、状態変化、副作用、境界条件。
  5. コードを確認できない、または証拠が不完全な場合は、その旨を明確に伝え、推測と検証済みのソース情報を分離します。
  6. 説明は読みやすく保ちます:最初に簡潔な回答を示し、詳細をコードに基づいて記述します。

次の形式を推奨します:

簡潔な回答。

関連するパスは `path/to/file.ext:line` から始まり、そこでは...

```language
小さな焦点を絞ったスニペット
```

これが `path/to/other.ext:line` 内の `symbol` を呼び出し、これは...

関連スキル