doc-issue-readme

Post structured documentation to GitHub issues via gh issue comment commands.

18|5|Updated Nov 3, 2025
One-click install
npx skills add https://github.com/mvillmow/ml-odyssey --skill doc-issue-readme
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-issue-readme
Source: https://github.com/mvillmow/ml-odyssey/tree/main/.claude/skills/doc-issue-readme
Command: npx skills add https://github.com/mvillmow/ml-odyssey --skill doc-issue-readme

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires github-cli, and includes scripts (resource) components.

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.

Frequently Asked Questions about doc-issue-readme

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I document GitHub issues with structured templates automatically?

Post structured documentation to GitHub issues as comments using templated sections for objectives, approach, files to modify, success criteria, and progress tracking. This Skill generates issue-specific README files with pre-populated GitHub issue details, eliminating manual template setup and ensuring consistent documentation across all issues.

What's the best way to track progress and decisions on a GitHub issue?

Use structured issue documentation with dedicated sections for progress updates, completion summaries, and findings consolidation. This Skill automates creation of these sections within GitHub issue comments, keeping all decisions and implementation notes directly tied to the issue for team visibility.

Can I automate documentation when starting a new GitHub issue?

Yes. This Skill generates a README with issue details, objectives, deliverables, and success criteria automatically populated from your GitHub issue. Run it when starting work to define clear goals and create a single source of truth for implementation tracking.

Do I need to manually fill out issue documentation templates?

No. This Skill eliminates manual template entry by generating pre-populated documentation with GitHub issue context. It uses the github-cli dependency to fetch issue details and structure them into templated sections, reducing setup time and human error.

How does this integrate with existing GitHub project workflows?

The Skill posts documentation directly to GitHub issues as comments using gh issue commands, keeping it native to your GitHub workflow. No external tools or separate documentation systems needed—everything stays within your repository and issue tracking.

What happens if I need to update documentation as work progresses?

The Skill structures sections for progress updates and completion summaries that you add as work evolves. The templated format keeps all updates organized and traceable within the issue thread, enabling clear visibility of decisions, blockers, and completion status.