Transform this Python script into a polished, beginner-friendly project by refactoring the code, adding clear instructional comments, and generating a complete markdown tutorial.
Start a fresh conversation. Replace the highlighted placeholders.
Use comment-code-generate-a-tutorial to refactor [Python script], add beginner-friendly instructional comments, and create a README.md tutorial covering setup, logic, usage, and optional sample output.
Required inputs
[Python script]
User-approved starter prompt based on a pinned source version; check current skill requirements before running. Task evidence ↗
SKILL.md
name: comment-code-generate-a-tutorialdescription: '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.
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
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
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