Transforma archivos de código en recursos de aprendizaje mediante la adición de comentarios educativos con contexto, adaptados a niveles de conocimiento específicos.
- Estrellas en GitHub
- 41.038
- Archivos
- 1
- Último commit
- 11 nov 2026
- Licencia
- MIT
- Herramientas permitidas
- —
¿Qué hace la skill add-educational-comments?
Transforma archivos de código en recursos de aprendizaje mediante la adición de comentarios educativos con contexto, adaptados a niveles de conocimiento específicos.
Resumen generado a partir del SKILL.md de la skill.
Sobre la skill add-educational-comments
La función principal de este SKILL es convertir el código fuente en materiales de aprendizaje interactivos. Está diseñado para desarrolladores y estudiantes que desean transformar archivos existentes en recursos educativos inyectando explicaciones contextualizadas directamente en el código. Un agente debe cargar esta herramienta cuando un usuario proporcione un archivo y solicite una comprensión más profunda de la sintaxis, las decisiones de diseño o los patrones arquitectónicos presentes en dicho archivo.
El proceso consiste en analizar el código y añadir comentarios que expliquen el razonamiento detrás de modismos específicos o aspectos internos del lenguaje. La herramienta busca aumentar la longitud del archivo en un 125% mediante estas notas, aunque respeta un límite estricto de 400 líneas nuevas para evitar un exceso de contenido. Es compatible con varios lenguajes de programación, incluyendo Python, Haskell, F#, Nim, Cobra, YAML y Makefiles.
Los usuarios pueden personalizar la experiencia mediante parámetros específicos como el detalle de los comentarios (Comment Detail), la repetitividad (Repetitiveness) y el nivel de conocimiento del usuario (User Knowledge) en una escala del 1 al 3. El SKILL también ofrece referencias por número de línea (Line Number Referencing) para conectar explicaciones relacionadas y puede anidar comentarios dentro de bloques de código para mantener la indentación y la legibilidad adecuadas.
Lo que un agente puede hacer con ella
- 1Onboarding de desarrolladores juniorTransforma una base de código compleja en un tutorial guiado añadiendo explicaciones fundamentales para principiantes.
- 2Profundizar en la experiencia del lenguajeAñade contexto técnico sobre rendimiento y arquitectura para profesionales avanzados.
- 3Estandarizar la documentación técnicaAplica notas educativas consistentes a los archivos manteniendo los estilos originales de codificación e indentación.
- 4Crear guías de estudio estructuradasGenera una secuencia numerada de notas para vincular conceptos de programación relacionados a lo largo de un archivo.
Escrito a partir del SKILL.md de la skill. Cada caso de uso se verifica con una cita del mismo.
Cómo instalar la skill add-educational-comments
Cada comando copia la carpeta de la skill al directorio de skills del cliente. Reinicia el cliente o inicia una nueva sesión para cargarla.Instalar la skill add-educational-comments en Claude Code
~/.claude/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.claude/skills/add-educational-commentsInstalar la skill add-educational-comments en Claude Code (project)
.claude/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments .claude/skills/add-educational-commentsInstalar la skill add-educational-comments en Codex
~/.agents/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.agents/skills/add-educational-commentsInstalar la skill add-educational-comments en Gemini CLI
~/.gemini/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.gemini/skills/add-educational-commentsInstalar la skill add-educational-comments en 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
Verificaciones automáticas
Ejecutado 15 nov 2026Informe completo →Superó nuestras comprobaciones automáticas. No es una auditoría de seguridad: lee los scripts antes de dejar que un agente los ejecute. Cómo funcionan las verificaciones · Qué corregir para obtener más puntos
- Repositorio de origen vinculado y accesiblegithub/awesome-copilot/skills/add-educational-comments is public and reachablegithub.com/github/awesome-copilot/tree/HEAD/skills/add-educa ↗Aprobado
- Licencia de código abierto (OSI)MITspdx.org/licenses/MIT.html ↗Aprobado
- Commit o lanzamiento en el último añoLast commit 2026-11-11github.com/github/awesome-copilot/commits ↗Aprobado
- Sin descargar y ejecutar ni robo de credenciales en los scriptsNo scripts in the skill folderAprobado
- Sin instrucciones ocultas en SKILL.mdNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗Aprobado
- Las herramientas preaprobadas están acotadasNo pre-approved tools; the agent asks before using onegithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗Aprobado
- SKILL.md sigue el formato de Agent Skillsthe description does not say when to use the skillgithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗Hallazgo
SKILL.md
Ver en 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.
Archivos de esta skill
1Preguntas sobre la skill add-educational-comments
¿Cómo instalo la skill add-educational-comments en Claude Code?
Ejecuta npx degit github/awesome-copilot/skills/add-educational-comments ~/.claude/skills/add-educational-comments. Claude Code carga las skills desde ~/.claude/skills (todos los proyectos) o .claude/skills (un proyecto) y usa una skill cuando su descripción coincide con la tarea.
¿Qué clientes pueden usar la skill add-educational-comments?
Cualquier cliente que lea el formato Agent Skills: Claude Code, Codex, Gemini CLI y claude.ai (subir como ZIP). Los scripts de la skill se ejecutan solo donde el cliente permite la ejecución de código.
¿Cuánto contenido se añadirá a mi archivo?
La herramienta tiene como objetivo aumentar el recuento total de líneas en un 125% mediante comentarios educativos, con un límite máximo de 400 líneas nuevas.
¿Cambiará la herramienta la funcionalidad o el formato de mi código?
No, la herramienta está diseñada para mantener la estructura, la codificación, la indentación y la integridad de la compilación del archivo.
¿Qué pasa si no proporciono un nombre de archivo?
El agente te pedirá que proporciones uno o varios archivos, ofreciendo una lista numerada de coincidencias cercanas si se encuentran múltiples archivos.