Agent skill · writing content · github
comment-code-generate-a-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.
Why this skill is useful
Codifies a structured approach to creating beginner-friendly documentation and comments, which the AI could infer but now has clear guidelines.
What it needs
About 1k tokens when loaded. Last updated 2026-08-07. 37,534 stars on the source repository.
What this skill does
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
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills github/comment-code-generate-a-tutorial