Mengubah file kode menjadi sumber belajar dengan menambahkan komentar edukatif berbasis konteks yang disesuaikan dengan tingkat pemahaman tertentu.
- Bintang GitHub
- 41.038
- File
- 1
- Commit terakhir
- 11 Nov 2026
- Lisensi
- MIT
- Tool yang diizinkan
- —
Apa fungsi skill add-educational-comments?
Mengubah file kode menjadi sumber belajar dengan menambahkan komentar edukatif berbasis konteks yang disesuaikan dengan tingkat pemahaman tertentu.
Ringkasan dibuat dari SKILL.md skill ini.
Tentang skill add-educational-comments
Mengubah source code menjadi materi pembelajaran interaktif adalah fungsi utama dari SKILL ini. Dirancang untuk developer dan pelajar yang ingin mengubah file yang sudah ada menjadi sumber edukasi dengan menyisipkan penjelasan berbasis konteks langsung ke dalam kode. Agent harus memuat tool ini saat pengguna memberikan sebuah file dan meminta wawasan lebih dalam mengenai sintaks, pilihan desain, atau pola arsitektur yang ada di dalam file tersebut.
Prosesnya melibatkan analisis kode dan penambahan komentar yang menjelaskan alasan di balik idiom tertentu atau mekanisme internal bahasa pemrograman. Tool ini bertujuan untuk menambah panjang file sebesar 125% melalui catatan tersebut, namun tetap mematuhi batas maksimal 400 baris baru untuk mencegah file menjadi terlalu besar. Tool ini mendukung berbagai bahasa pemrograman termasuk Python, Haskell, F#, Nim, Cobra, YAML, dan Makefiles.
Pengguna dapat menyesuaikan pengalaman ini melalui parameter spesifik seperti Comment Detail, Repetitiveness, dan tingkat User Knowledge pada skala 1 hingga 3. SKILL ini juga menawarkan Line Number Referencing untuk menghubungkan penjelasan yang terkait dan dapat menyisipkan komentar di dalam code block untuk menjaga indentasi serta keterbacaan yang tepat.
Apa yang bisa dilakukan agent dengannya
- 1Onboarding junior developerMengubah codebase yang kompleks menjadi tutorial terpandu dengan menambahkan penjelasan dasar untuk pemula.
- 2Memperdalam keahlian bahasa pemrogramanMenambahkan konteks teknis terkait performa dan arsitektur untuk praktisi tingkat lanjut.
- 3Standardisasi dokumentasi teknisMenerapkan catatan edukatif yang konsisten ke dalam file sambil tetap mempertahankan gaya encoding dan indentasi asli.
- 4Membuat panduan belajar terstrukturMenghasilkan urutan catatan bernomor untuk menghubungkan konsep pemrograman yang terkait di seluruh file.
Ditulis dari SKILL.md milik skill tersebut. Setiap use case diverifikasi dengan kutipan darinya.
Cara install skill add-educational-comments
Setiap perintah menyalin folder skill ke direktori skills client. Restart client atau mulai sesi baru untuk memuatnya.Install skill add-educational-comments di Claude Code
~/.claude/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.claude/skills/add-educational-commentsInstall skill add-educational-comments di Claude Code (project)
.claude/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments .claude/skills/add-educational-commentsInstall skill add-educational-comments di Codex
~/.agents/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.agents/skills/add-educational-commentsInstall skill add-educational-comments di Gemini CLI
~/.gemini/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.gemini/skills/add-educational-commentsInstall skill add-educational-comments di Claude.ai
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
Pengecekan otomatis
Berjalan 15 Nov 2026Laporan lengkap →Lolos cek otomatis kami. Ini bukan audit keamanan: baca skripnya sebelum membiarkan agent menjalankannya. Cara kerja checks · Yang perlu diperbaiki untuk menambah poin
- Source repository terhubung dan dapat dijangkaugithub/awesome-copilot/skills/add-educational-comments is public and reachablegithub.com/github/awesome-copilot/tree/HEAD/skills/add-educa ↗Lolos
- Lisensi open source (OSI)MITspdx.org/licenses/MIT.html ↗Lolos
- Ada commit atau release dalam satu tahun terakhirLast commit 2026-11-11github.com/github/awesome-copilot/commits ↗Lolos
- Skrip tanpa unduh-lalu-jalankan atau pencurian kredensialNo scripts in the skill folderLolos
- Tidak ada instruksi tersembunyi di SKILL.mdNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗Lolos
- Tool yang diizinkan otomatis dibatasiNo pre-approved tools; the agent asks before using onegithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗Lolos
- SKILL.md mengikuti format Agent Skillsthe description does not say when to use the skillgithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗Temuan
SKILL.md
Lihat di GitHubAdd 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.
Berkas dalam skill ini
1Pertanyaan seputar skill add-educational-comments
Bagaimana cara install skill add-educational-comments di Claude Code?
Jalankan npx degit github/awesome-copilot/skills/add-educational-comments ~/.claude/skills/add-educational-comments. Claude Code memuat skill dari ~/.claude/skills (semua proyek) atau .claude/skills (satu proyek) dan menggunakan skill saat deskripsinya cocok dengan tugas.
Client mana saja yang bisa menggunakan skill add-educational-comments?
Client apa pun yang membaca format Agent Skills: Claude Code, Codex, Gemini CLI, dan claude.ai (unggah sebagai ZIP). Script dalam skill hanya berjalan di client yang mengizinkan eksekusi kode.
Seberapa banyak konten yang akan ditambahkan ke file saya?
Tool ini bertujuan untuk menambah total baris sebanyak 125% menggunakan komentar edukatif, dengan batas maksimal 400 baris baru.
Apakah tool ini akan mengubah fungsionalitas atau format kode saya?
Tidak, tool ini dirancang untuk menjaga struktur, encoding, indentasi, dan kebenaran build pada file tersebut.
Apa yang terjadi jika saya tidak memberikan nama file?
Agent akan meminta Anda untuk memberikan satu atau beberapa file, dan akan menawarkan daftar bernomor dari file yang paling mendekati jika ditemukan beberapa file yang cocok.