doc-issue-readme
CommunityGenerate issue docs, track progress.
Authormvillmow
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill automates the creation of structured, issue-specific documentation (/notes/issues/<number>/README.md), ensuring clear objectives, deliverables, and progress tracking for every GitHub issue. It streamlines documentation, saving time and reducing complexity.
Core Features & Use Cases:
- Template-Based Generation: Creates a README from a template, pre-populated with issue details from GitHub for a quick start.
- Structured Progress Tracking: Provides sections for objectives, deliverables, success criteria, and implementation notes for clear project management.
- Use Case: When you start working on a new GitHub issue, use this skill to generate its dedicated README. This will help you define clear objectives, list deliverables, and track your implementation progress directly within the repository.
Quick Start: Use the doc-issue-readme skill to generate documentation for GitHub issue number 42.
Dependency Matrix
Required Modules
github-cli
Components
scripts
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: doc-issue-readme Download link: https://github.com/mvillmow/ml-odyssey/archive/main.zip#doc-issue-readme Please download this .zip file, extract it, and install it in the .claude/skills/ directory.