comment-code-generate-a-tutorial
Refactor Python scripts into beginner-friendly projects with instructional comments and markdown tutorials.
Works with
0
total installs
0
this week
28.7K
GitHub stars
0
upvotes
Install Skill
Run in your terminal
0
installs
0
this week
28.7K
stars
What it does
Applies PEP 8 style guide compliance and standard Python best practices to improve code quality
Adds instructional comments throughout the code explaining logic, reasoning, and importance for learners
Generates a complete README.md tutorial with project overview, setup instructions, code breakdown, usage examples, and sample output
Renames unclear variables and functions for
Installation Guide
How to use comment-code-generate-a-tutorial on Cursor
AI-first code editor with Composer
Prerequisites
Before installing skills in Cursor, ensure your development environment meets these requirements:
- ›Cursor installed and configured on your machine
- ›Node.js 16+ with npm — verify with
node --version - ›Active project directory where you want to add
comment-code-generate-a-tutorial
Run the install command
Execute the skills CLI command in your project's root directory to begin installation:
Fetches comment-code-generate-a-tutorial from github/awesome-copilot and configures it for Cursor.
Select Cursor when prompted
The CLI shows a list of agents. Use arrow keys and space to select Cursor:
Verify installation
Confirm successful installation by checking the skill directory location:
Restart Cursor to activate comment-code-generate-a-tutorial. Access via /comment-code-generate-a-tutorial in your agent's command palette.
Security Notice
We perform automated surface-level scans (Gen AI Scanner, Socket, Snyk) during installation. These checks detect common vulnerabilities but do not guarantee complete security. Always review skill source code and verify the publisher's reputation before production use.
Skills execute code in your environment. Always review source, verify the publisher, and test in isolation before production.
Documentation
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.mdfile
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
List & Monetize Your Skill
Submit your Claude Code skill and start earning
Use Cases
User Story & Requirements Generation
Create detailed user stories, acceptance criteria, and feature specs
Example
Generate user stories for 'password reset feature' with acceptance criteria, edge cases, and test scenarios
Reduce spec writing time by 50%, ensure comprehensive coverage
Competitive Analysis
Research competitors, compare features, identify gaps
Example
Analyze 5 competitor products, create feature comparison matrix, suggest differentiation opportunities
Complete competitive research in 2 hours instead of 2 days
Roadmap Prioritization
Evaluate features using frameworks (RICE, ICE, Kano) and create prioritized backlogs
Example
Score 20 feature ideas using RICE framework, generate prioritized roadmap with rationale
Make data-driven prioritization decisions faster
Stakeholder Communication
Draft PRDs, status updates, and stakeholder presentations
Example
Create executive summary of Q3 roadmap, monthly progress report, feature launch announcement
Save 3-5 hours/week on communication overhead
Implementation Guide
Prerequisites
- ›Claude Desktop or compatible AI client
- ›Access to product documentation and roadmap tools (Jira, Notion, etc.)
- ›Understanding of product management frameworks (RICE, Jobs-to-be-Done, etc.)
- ›Stakeholder contact information and communication channels
Time Estimate
30-60 minutes to see productivity improvements
Steps
- 1Install product management skill
- 2Start with user story generation for known feature
- 3Progress to competitive analysis: research 2-3 competitors
- 4Use for roadmap prioritization: apply RICE/ICE scoring
- 5Draft stakeholder communications and refine based on feedback
- 6Build template library for recurring PM tasks
- 7Share effective prompts with product team
Common Pitfalls
- ⚠Not validating competitive research—verify facts before sharing
- ⚠Accepting user stories without involving engineering team
- ⚠Over-relying on frameworks without qualitative judgment
- ⚠Not customizing outputs to company culture and communication style
- ⚠Skipping stakeholder validation of generated requirements
Best Practices
✓ Do
- +Validate research and competitive analysis with real data
- +Collaborate with engineering when generating technical requirements
- +Customize frameworks and templates to your company context
- +Use skill for first drafts, refine with stakeholder input
- +Document successful prompt patterns for PM tasks
- +Combine AI efficiency with human judgment and intuition
✗ Don't
- −Don't publish competitive analysis without fact-checking
- −Don't finalize user stories without engineering review
- −Don't make prioritization decisions solely on AI scoring
- −Don't skip customer validation of generated requirements
- −Don't ignore company-specific context and culture
💡 Pro Tips
- ★Provide context: company goals, constraints, customer feedback
- ★Ask for alternatives: 'Show 3 ways to prioritize this roadmap'
- ★Request stakeholder-specific formatting: 'Executive summary vs. engineering spec'
- ★Use skill for 70% generation + 30% customization to company needs
When to Use This
✓ Use when
Use for user story writing, competitive research, roadmap prioritization, stakeholder communication, and PRD drafting. Best for reducing repetitive documentation and research work.
✗ Avoid when
Avoid for strategic product vision (requires deep customer empathy), pricing decisions (needs market and financial expertise), or when face-to-face customer discovery is more valuable than speed.
Learning Path
- 1Basic: user stories, feature specs, status updates
- 2Intermediate: competitive analysis, prioritization frameworks, PRDs
- 3Advanced: product strategy, go-to-market planning, OKR setting
- 4Expert: product vision, market positioning, business model innovation
Related Skills
premium-frontend-ui
178github/awesome-copilot
java-springboot
42github/awesome-copilot
clean-code-principles
66asyrafhussin/agent-skills
improve
68shadcn/improve
grill-me
388mattpocock/skills
premortem
197parcadei/continuous-claude-v3
Reviews
- HHana Shah★★★★★Dec 20, 2024
Keeps context tight: comment-code-generate-a-tutorial is the kind of skill you can hand to a new teammate without a long onboarding doc.
- DDhruvi Jain★★★★★Dec 16, 2024
Keeps context tight: comment-code-generate-a-tutorial is the kind of skill you can hand to a new teammate without a long onboarding doc.
- KKwame Thompson★★★★★Dec 16, 2024
Solid pick for teams standardizing on skills: comment-code-generate-a-tutorial is focused, and the summary matches what you get after install.
- NNoor Khan★★★★★Dec 16, 2024
comment-code-generate-a-tutorial has been reliable in day-to-day use. Documentation quality is above average for community skills.
- DDev Mehta★★★★★Dec 8, 2024
comment-code-generate-a-tutorial has been reliable in day-to-day use. Documentation quality is above average for community skills.
- KKwame Ramirez★★★★★Dec 4, 2024
comment-code-generate-a-tutorial fits our agent workflows well — practical, well scoped, and easy to wire into existing repos.
- SSoo Haddad★★★★★Nov 27, 2024
comment-code-generate-a-tutorial fits our agent workflows well — practical, well scoped, and easy to wire into existing repos.
- LLucas Sethi★★★★★Nov 23, 2024
comment-code-generate-a-tutorial has been reliable in day-to-day use. Documentation quality is above average for community skills.
- AAma Jain★★★★★Nov 11, 2024
Registry listing for comment-code-generate-a-tutorial matched our evaluation — installs cleanly and behaves as described in the markdown.
- OOshnikdeep★★★★★Nov 7, 2024
Registry listing for comment-code-generate-a-tutorial matched our evaluation — installs cleanly and behaves as described in the markdown.
showing 1-10 of 72
Discussion
Comments — not star reviews- No comments yet — start the thread.