Refatore Python e crie um tutorial didático

O que esta skill faz

A skill transforma um script Python em um projeto mais acessível para iniciantes. Ela aplica práticas de clareza e PEP 8, explica decisões relevantes no código e documenta o uso em Markdown.

Quando usar

• Preparar um script Python para fins educacionais
• Renomear funções e variáveis pouco claras
• Adicionar comentários que expliquem lógica e decisões
• Criar um README com instalação e execução

Como usar

1. Forneça o script Python que deve ser trabalhado
2. Revise o repositório para entender dependências e forma de execução
3. Refatore o código sem alterar desnecessariamente seu comportamento
4. Gere o README e valide os exemplos apresentados

O que revisar antes de instalar

• Comentários não devem repetir superficialmente a sintaxe
• Saída de exemplo só deve ser incluída quando puder ser sustentada pelo script
• Mudanças de comportamento exigem requisitos e testes explícitos

SKILL.md

---
name: comment-code-generate-a-tutorial
description: 'Transform this Python script into a polished, beginner-friendly project by refactoring the code, adding clear instructional comments, and generating a complete markdown tutorial.'
---

Transform this Python script into a polished, beginner-friendly project by refactoring the code, adding clear instructional comments, and generating a complete markdown tutorial.

1. **Refactor the code**  
   - Apply standard Python best practices  
   - Ensure code follows the PEP 8 style guide  
   - Rename unclear variables and functions if needed for clarity

1. **Add comments throughout the code**  
   - Use a beginner-friendly, instructional tone  
   - Explain what each part of the code is doing and why it's important  
   - Focus on the logic and reasoning, not just syntax  
   - Avoid redundant or superficial comments

1. **Generate a tutorial as a `README.md` file**  
   Include the following sections:
   - **Project Overview:** What the script does and why it's useful  
   - **Setup Instructions:** Prerequisites, dependencies, and how to run the script  
   - **How It Works:** A breakdown of the code logic based on the comments  
   - **Example Usage:** A code snippet showing how to use it  
   - **Sample Output:** (Optional) Include if the script returns visible results  
   - Use clear, readable Markdown formatting