Transforma arquivos de código em recursos de aprendizado ao adicionar comentários educativos contextuais adaptados a níveis específicos de conhecimento.
- Estrelas no GitHub
- 41.038
- Arquivos
- 1
- Último commit
- 11 de nov. de 2026
- Licença
- MIT
- Ferramentas permitidas
- —
O que a skill add-educational-comments faz?
Transforma arquivos de código em recursos de aprendizado ao adicionar comentários educativos contextuais adaptados a níveis específicos de conhecimento.
Resumo gerado a partir do SKILL.md da skill.
Sobre a skill add-educational-comments
Transformar código-fonte em materiais de aprendizado interativos é a função principal desta skill. Ela foi projetada para desenvolvedores e estudantes que desejam transformar arquivos existentes em recursos educacionais, injetando explicações contextuais diretamente no código. Um agente deve carregar esta ferramenta quando um usuário fornecer um arquivo e solicitar uma análise mais profunda da sintaxe, escolhas de design ou padrões arquiteturais presentes naquele arquivo.
O processo envolve analisar o código e adicionar comentários que explicam o raciocínio por trás de idiomas específicos ou detalhes internos da linguagem. A ferramenta visa aumentar o comprimento do arquivo em 125% por meio dessas notas, embora respeite um limite rígido de 400 novas linhas para evitar excesso de volume. Ela suporta várias linguagens de programação, incluindo Python, Haskell, F#, Nim, Cobra, YAML e Makefiles.
Os usuários podem personalizar a experiência por meio de parâmetros específicos, como Detalhe do Comentário, Repetitividade e níveis de Conhecimento do Usuário em uma escala de 1 a 3. A skill também oferece Referência de Número de Linha para conectar explicações relacionadas e pode aninhar comentários dentro de blocos de código para manter a indentação e a legibilidade adequadas.
O que um agente pode fazer com ela
- 1Onboarding de desenvolvedores júniorTransforme uma base de código complexa em um tutorial guiado, adicionando explicações fundamentais para iniciantes.
- 2Aprofundar expertise em linguagensAdicione contexto técnico sobre performance e arquitetura para profissionais avançados.
- 3Padronizar documentação técnicaAplique notas educativas consistentes aos arquivos, mantendo os estilos originais de codificação e indentação.
- 4Criar guias de estudo estruturadosGere uma sequência numerada de notas para vincular conceitos de programação relacionados ao longo de um arquivo.
Escrito a partir do SKILL.md da skill. Cada caso de uso é verificado com uma citação dele.
Como instalar a skill add-educational-comments
Cada comando copia a pasta da skill para o diretório de skills do cliente. Reinicie o cliente ou inicie uma nova sessão para carregá-la.Instalar a skill add-educational-comments no Claude Code
~/.claude/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.claude/skills/add-educational-commentsInstalar a skill add-educational-comments no Claude Code (project)
.claude/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments .claude/skills/add-educational-commentsInstalar a skill add-educational-comments no Codex
~/.agents/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.agents/skills/add-educational-commentsInstalar a skill add-educational-comments no Gemini CLI
~/.gemini/skills/add-educational-comments/SKILL.md
$ npx degit github/awesome-copilot/skills/add-educational-comments ~/.gemini/skills/add-educational-commentsInstalar a skill add-educational-comments no 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
Verificações automatizadas
Executado em 15 de nov. de 2026Relatório completo →Passou nas nossas verificações automáticas. Não é uma auditoria de segurança: leia os scripts antes de deixar um agente executá-los. Como as verificações funcionam · O que corrigir para ganhar mais pontos
- Repositório de origem vinculado e acessívelgithub/awesome-copilot/skills/add-educational-comments is public and reachablegithub.com/github/awesome-copilot/tree/HEAD/skills/add-educa ↗Passou
- Licença de código aberto (OSI)MITspdx.org/licenses/MIT.html ↗Passou
- Commit ou release no último anoLast commit 2026-11-11github.com/github/awesome-copilot/commits ↗Passou
- Sem baixar e executar nem roubo de credenciais nos scriptsNo scripts in the skill folderPassou
- Sem instruções ocultas no SKILL.mdNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗Passou
- Ferramentas pré-aprovadas são restritasNo pre-approved tools; the agent asks before using onegithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗Passou
- O SKILL.md segue o formato Agent Skillsthe description does not say when to use the skillgithub.com/github/awesome-copilot/blob/HEAD/skills/add-educa ↗Problema encontrado
SKILL.md
Ver no 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.
Arquivos desta skill
1Perguntas sobre a skill add-educational-comments
Como instalo a skill add-educational-comments no Claude Code?
Execute npx degit github/awesome-copilot/skills/add-educational-comments ~/.claude/skills/add-educational-comments. O Claude Code carrega skills de ~/.claude/skills (todos os projetos) ou .claude/skills (um projeto) e usa uma skill quando a descrição dela corresponde à tarefa.
Quais clientes podem usar a skill add-educational-comments?
Qualquer cliente que leia o formato Agent Skills: Claude Code, Codex, Gemini CLI e claude.ai (envie como ZIP). Scripts da skill são executados apenas onde o cliente permite execução de código.
Quanto conteúdo será adicionado ao meu arquivo?
A ferramenta visa aumentar a contagem total de linhas em 125% usando comentários educativos, com um limite máximo de 400 novas linhas.
A ferramenta alterará a funcionalidade ou a formatação do meu código?
Não, a ferramenta foi projetada para manter a estrutura, codificação, indentação e a integridade do build do arquivo.
O que acontece se eu não fornecer um nome de arquivo?
O agente solicitará que você forneça um ou mais arquivos, oferecendo uma lista numerada de correspondências próximas caso múltiplos arquivos sejam encontrados.