comment-code-generate-a-tutorial
Faz seu agente transformar scripts em projetos fáceis de entender, com comentários claros e um tutorial completo. Ideal para compartilhar conhecimento e facilitar o aprendizado.
O que ela faz
Esta ferramenta transforma um script de programação Python em um projeto fácil de entender. Ela organiza o código, adiciona explicações passo a passo e cria um guia completo em texto para que qualquer pessoa possa aprender a usá-lo.
Quando usar
- ✓Quando você tem um código Python que não está claro.
- ✓Ao querer ensinar alguém a usar um script.
- ✓Para transformar um código simples em um projeto completo e explicativo.
Exemplo do que pedir para a IA
“Transforme este código Python em um projeto para iniciantes, com explicações e um guia.”
Quer saber mais? Abra as seções abaixo.
Como usar
O jeito mais fácil: copie a mensagem abaixo e cole no Claude, ChatGPT, Cursor ou outra IA. Ela lê a skill e segue as instruções.
Link da skill
Mensagem pronta para colar
Como funciona
A IA primeiro melhora o código seguindo boas práticas. Depois, adiciona comentários explicativos em cada parte. Por fim, gera um arquivo de texto (Markdown) com um guia completo sobre o projeto.
Instalação
Jeito mais fácil: copie o link da skill e cole no Claude, ChatGPT ou Cursor pedindo para seguir as instruções.
No terminal (Claude Code, Codex, Cursor), na pasta do projeto:
npx skills add github/awesome-copilot --skill comment-code-generate-a-tutorialOu baixe só o arquivo:
curl -L https://raw.githubusercontent.com/github/awesome-copilot/main/skills/comment-code-generate-a-tutorial/SKILL.md -o SKILL.mdConteúdo técnico (SKILL.md)
Tradução do texto original do autor no GitHub. Os comandos e códigos estão como no original.
Transforme este script Python em um projeto polido e amigável para iniciantes, refatorando o código, adicionando comentários instrucionais claros e gerando um tutorial completo em Markdown.
Refatore o código
- Aplique as melhores práticas padrão do Python
- Garanta que o código siga o guia de estilo PEP 8
- Renomeie variáveis e funções pouco claras, se necessário, para maior clareza
Adicione comentários em todo o código
- Use um tom amigável e instrucional para iniciantes
- Explique o que cada parte do código está fazendo e por que é importante
- Concentre-se na lógica e no raciocínio, não apenas na sintaxe
- Evite comentários redundantes ou superficiais
Gere um tutorial como um arquivo
README.mdInclua as seguintes seções:- Visão Geral do Projeto: O que o script faz e por que ele é útil
- Instruções de Configuração: Pré-requisitos, dependências e como executar o script
- Como Funciona: Uma análise da lógica do código com base nos comentários
- Exemplo de Uso: Um trecho de código mostrando como usá-lo
- Exemplo de Saída: (Opcional) Inclua se o script retornar resultados visíveis
- Use formatação Markdown clara e legível
Perguntas frequentes
O que significa 'refatorar o código'?
Significa organizar e melhorar o código existente sem mudar o que ele faz, para torná-lo mais limpo e fácil de ler.
Por que adicionar comentários?
Comentários são notas dentro do código que explicam o que cada parte faz, ajudando quem lê a entender a lógica.
O que é um tutorial em Markdown?
É um guia escrito em um formato de texto simples que pode ser facilmente transformado em páginas web ou documentos bem formatados, como um README de projeto.
Detalhes
Descrição original do autor
Transform this Python script into a polished, beginner-friendly project by refactoring the code, adding clear instructional comments, and generating a complete markdown tutorial.
repo: github/awesome-copilot
Popularidade
- Estrelas no GitHub
- 40 mil
- Posição no ranking
- #5056
- Licença
- MIT
- Atualizada em
- 15/10/2026
Comentários
- …
Mais skills deste repositório
acquire-codebase-knowledge
Ajuda seu agente a entender e documentar um projeto de código existente. É útil para novas pessoas entrarem no projeto ou para ter uma visão geral da arquitetura.
github/awesome-copilot
acreadiness-assess
Faz seu agente avaliar a prontidão de um projeto para IA e gerar um relatório. É útil para entender o quão bem um projeto está preparado para usar ferramentas de IA.
github/awesome-copilot
acreadiness-generate-instructions
Ajuda seu agente a criar instruções para ferramentas de IA baseadas em uma avaliação. É útil para melhorar a forma como a IA interage com o código e fecha lacunas identificadas.
github/awesome-copilot
acreadiness-policy
Faz seu agente ajudar a definir ou aplicar políticas para avaliação de projetos de IA. É útil para padronizar a forma como os projetos são avaliados e garantir conformidade.
github/awesome-copilot
Skills parecidas
benchmark-optimization-loop
Faz seu agente melhorar a velocidade de algo de forma medida. Ele testa várias versões e escolhe a mais rápida que ainda funciona corretamente.
affaan-m/ECC
change-impact
Ajuda seu agente a analisar o impacto de mudanças no código antes de fazê-las. Ele compara o planejado com o real depois, cobrindo caminhos, dados, testes e documentação. É útil para mudanças arriscadas ou que afetam várias partes do sistema.
affaan-m/ECC
click-path-audit
Faz seu agente rastrear todos os botões e interações do usuário para achar bugs. Ele encontra problemas onde funções parecem funcionar sozinhas, mas falham juntas. Útil quando bugs persistem mesmo após depuração.
affaan-m/ECC