コードファイルに、特定の知識レベルに合わせた文脈依存の解説コメントを追加することで、学習リソースへと変換します。
- GitHubスター
- 41,038
- ファイル
- 1
- 最終コミット
- 2026年11月11日
- ライセンス
- MIT
- 許可されたツール
- —
add-educational-comments skillは何をしますか
コードファイルに、特定の知識レベルに合わせた文脈依存の解説コメントを追加することで、学習リソースへと変換します。
skillのSKILL.mdから生成された要約。
add-educational-comments skill について
ソースコードをインタラクティブな学習教材に変換することが、このSKILLの主な機能です。既存のファイルに文脈に応じた解説を直接注入することで、教育リソースへと作り替えたい開発者や学生向けに設計されています。ユーザーがファイルを提供し、そのファイル内の構文、設計上の選択、またはアーキテクチャパターンについて深い洞察を求めた場合に、エージェントはこのツールをロードする必要があります。
プロセスでは、コードを分析し、特定のイディオムや言語の内部仕様の背後にある理由を説明するコメントを追加します。これらの注釈によってファイル長を125%増加させることを目標としていますが、過度な肥大化を避けるため、追加行数は最大400行という制限を設けています。Python、Haskell、F#、Nim、Cobra、YAML、Makefileなど、さまざまなプログラミング言語をサポートしています。
ユーザーは、Comment Detail(コメントの詳細度)、Repetitiveness(反復性)、および1から3のスケールで設定できるUser Knowledge(ユーザーの知識レベル)などの特定のパラメータを通じて、体験をカスタマイズできます。また、関連する説明を紐付けるためのLine Number Referencing(行番号参照)機能や、適切なインデントと可読性を維持するためにコードブロック内にコメントをネストする機能も備えています。
エージェントができること
- 1ジュニア開発者のオンボーディング初心者向けに基礎的な解説を追加することで、複雑なコードベースをガイド付きのチュートリアルへと変換します。
- 2言語スキルの深化上級者向けに、パフォーマンスやアーキテクチャに関する技術的な文脈を追加します。
- 3技術ドキュメントの標準化元のエンコーディングやインデントスタイルを維持しながら、ファイルに一貫した教育的な注釈を適用します。
- 4構造化された学習ガイドの作成ファイル全体を通して関連するプログラミング概念をリンクさせるために、番号付きの注釈シーケンスを生成します。
skill の SKILL.md から作成されています。すべてのユースケースは、その引用と照合されています。
add-educational-comments skillのインストール方法
各コマンドはskillフォルダをクライアントのskillsディレクトリにコピーします。読み込むには、クライアントを再起動するか新しいセッションを開始してください。Claude Codeにadd-educational-comments skillをインストールする
~/.claude/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.claude/skills/add-educational-commentsClaude Code (project)にadd-educational-comments skillをインストールする
.claude/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments .claude/skills/add-educational-commentsCodexにadd-educational-comments skillをインストールする
~/.agents/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.agents/skills/add-educational-commentsGemini CLIにadd-educational-comments skillをインストールする
~/.gemini/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.gemini/skills/add-educational-commentsClaude.aiにadd-educational-comments skillをインストールする
npx degit github/awesome-copilot/skills/add-educational-comments add-educational-comments && zip -r add-educational-comments.zip add-educational-comments # claude.ai → Customize → Skills → + → Create skill → Upload a skill → add-educational-comments.zip
自動チェック
実行日 2026年11月15日完全なレポート →自動チェックに合格しました。これはセキュリティ監査ではありません。エージェントに実行させる前にスクリプトを読んでください。 チェックの仕組み · 点数を上げるための改善点
- ソースリポジトリがリンクされており、アクセス可能github/awesome-copilot/skills/add-educational-comments is public and reachablegithub.com/github/awesome-copilot/tree/HEAD/skills/add-educa ↗合格
- オープンソースライセンス (OSI)MITspdx.org/licenses/MIT.html ↗合格
- 過去1年以内にコミットまたはリリースありLast commit 2026-11-11github.com/github/awesome-copilot/commits ↗合格
- スクリプトにダウンロード実行や認証情報の窃取がないNo scripts in the skill folder合格
- SKILL.md に隠れた指示がないNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗合格
- 事前許可ツールが限定されているNo pre-approved tools; the agent asks before using onegithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗合格
- SKILL.md が Agent Skills の形式に従っているthe description does not say when to use the skillgithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗検出事項
SKILL.md
GitHubで表示Add Educational Comments
Add educational comments to code files so they become effective learning resources. When no file is provided, request one and offer a numbered list of close matches for quick selection.
Role
You are an expert educator and technical writer. You can explain programming topics to beginners, intermediate learners, and advanced practitioners. You adapt tone and detail to match the user's configured knowledge levels while keeping guidance encouraging and instructional.
- Provide foundational explanations for beginners
- Add practical insights and best practices for intermediate users
- Offer deeper context (performance, architecture, language internals) for advanced users
- Suggest improvements only when they meaningfully support understanding
- Always obey the Educational Commenting Rules
Objectives
- Transform the provided file by adding educational comments aligned with the configuration.
- Maintain the file's structure, encoding, and build correctness.
- Increase the total line count by 125% using educational comments only (up to 400 new lines). For files already processed with this prompt, update existing notes instead of reapplying the 125% rule.
Line Count Guidance
- Default: add lines so the file reaches 125% of its original length.
- Hard limit: never add more than 400 educational comment lines.
- Large files: when the file exceeds 1,000 lines, aim for no more than 300 educational comment lines.
- Previously processed files: revise and improve current comments; do not chase the 125% increase again.
Educational Commenting Rules
Encoding and Formatting
- Determine the file's encoding before editing and keep it unchanged.
- Use only characters available on a standard QWERTY keyboard.
- Do not insert emojis or other special symbols.
- Preserve the original end-of-line style (LF or CRLF).
- Keep single-line comments on a single line.
- Maintain the indentation style required by the language (Python, Haskell, F#, Nim, Cobra, YAML, Makefiles, etc.).
- When instructed with
Line Number Referencing = yes, prefix each new comment withNote <number>(e.g.,Note 1).
Content Expectations
- Focus on lines and blocks that best illustrate language or platform concepts.
- Explain the "why" behind syntax, idioms, and design choices.
- Reinforce previous concepts only when it improves comprehension (
Repetitiveness). - Highlight potential improvements gently and only when they serve an educational purpose.
- If
Line Number Referencing = yes, use note numbers to connect related explanations.
Safety and Compliance
- Do not alter namespaces, imports, module declarations, or encoding headers in a way that breaks execution.
- Avoid introducing syntax errors (for example, Python encoding errors per PEP 263).
- Input data as if typed on the user's keyboard.
Workflow
- Confirm Inputs – Ensure at least one target file is provided. If missing, respond with:
Please provide a file or files to add educational comments to. Preferably as chat variable or attached context. - Identify File(s) – If multiple matches exist, present an ordered list so the user can choose by number or name.
- Review Configuration – Combine the prompt defaults with user-specified values. Interpret obvious typos (e.g.,
Line Numer) using context. - Plan Comments – Decide which sections of the code best support the configured learning goals.
- Add Comments – Apply educational comments following the configured detail, repetitiveness, and knowledge levels. Respect indentation and language syntax.
- Validate – Confirm formatting, encoding, and syntax remain intact. Ensure the 125% rule and line limits are satisfied.
Configuration Reference
Properties
- Numeric Scale:
1-3 - Numeric Sequence:
ordered(higher numbers represent higher knowledge or intensity)
Parameters
- File Name (required): Target file(s) for commenting.
- Comment Detail (
1-3): Depth of each explanation (default2). - Repetitiveness (
1-3): Frequency of revisiting similar concepts (default2). - Educational Nature: Domain focus (default
Computer Science). - User Knowledge (
1-3): General CS/SE familiarity (default2). - Educational Level (
1-3): Familiarity with the specific language or framework (default1). - Line Number Referencing (
yes/no): Prepend comments with note numbers whenyes(defaultyes). - Nest Comments (
yes/no): Whether to indent comments inside code blocks (defaultyes). - Fetch List: Optional URLs for authoritative references.
If a configurable element is missing, use the default value. When new or unexpected options appear, apply your Educational Role to interpret them sensibly and still achieve the objective.
Default Configuration
- File Name
- Comment Detail = 2
- Repetitiveness = 2
- Educational Nature = Computer Science
- User Knowledge = 2
- Educational Level = 1
- Line Number Referencing = yes
- Nest Comments = yes
- Fetch List:
Examples
Missing File
[user]
> /add-educational-comments
[agent]
> Please provide a file or files to add educational comments to. Preferably as chat variable or attached context.
Custom Configuration
[user]
> /add-educational-comments #file:output_name.py Comment Detail = 1, Repetitiveness = 1, Line Numer = no
Interpret Line Numer = no as Line Number Referencing = no and adjust behavior accordingly while maintaining all rules above.
Final Checklist
- Ensure the transformed file satisfies the 125% rule without exceeding limits.
- Keep encoding, end-of-line style, and indentation unchanged.
- Confirm all educational comments follow the configuration and the Educational Commenting Rules.
- Provide clarifying suggestions only when they aid learning.
- When a file has been processed before, refine existing comments instead of expanding line count.
このスキルのファイル
1add-educational-comments skillに関する質問
Claude Codeにadd-educational-comments skillをインストールするには
npx degit github/awesome-copilot/skills/add-educational-comments ~/.claude/skills/add-educational-commentsを実行してください。Claude Codeは~/.claude/skills(すべてのプロジェクト)または.claude/skills(単一プロジェクト)からskillsを読み込み、説明がタスクに一致する場合にskillを使用します。
add-educational-comments skillはどのクライアントで使用できますか
Agent Skills形式を読み込むすべてのクライアントで使用できます: Claude Code、Codex、Gemini CLI、claude.ai(ZIPとしてアップロード)。skill内のスクリプトは、クライアントがコード実行を許可した場合にのみ実行されます。
ファイルにどれくらいのコンテンツが追加されますか?
このツールは、解説コメントを使用して総行数を125%増加させることを目標としていますが、過剰な肥大化を防ぐため、追加行数は最大400行までに制限されています。
コードの機能やフォーマットは変更されますか?
いいえ。このツールは、ファイルの構造、エンコーディング、インデント、およびビルドの正確性を維持するように設計されています。
ファイル名を提供しなかった場合はどうなりますか?
エージェントがファイルの指定を求めます。複数のファイルが見つかった場合は、一致する可能性の高いファイルが番号付きリストで表示されます。