explaining-code について
コードを会話形式で説明するためのスキルです。身近な例えから始め、ASCII 図、段階的な解説、よくある注意点を含める構成を定めています。
主な機能
- 01身近な例えから始める
- 02ASCIIで流れや構造を示す
- 03コードの動作を順に説明する
- 04よくある注意点を挙げる
活用シーン
- 01新しいチームメンバーへのコード経路の説明
- 02例えを使った複雑な概念の解説
- 03コードの流れとよくある誤りの明確化
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/explaining-codeを入力して読み込まれたか確認します。
詳細
コードを説明するときは、必ず次の内容を含めてください。
- たとえ話から始める：コードを日常生活の何かにたとえます
- 図を描く：ASCII アートでフロー、構造、または関係を示します
- コードを順を追って説明する：何が起きるのかをステップごとに説明します
- 注意点を挙げる：よくある間違いや誤解を説明します
会話するような口調で説明してください。複雑な概念には、複数のたとえ話を使ってください。
コメント
Markdown 対応