issue-documentation

What problem does it solve?

This Skill provides a standardized template for documenting issues and bug reports, ensuring all critical information is captured. It eliminates vague reports, speeds up diagnosis, and facilitates quicker resolution by providing clear problem descriptions, reproduction steps, and proposed solutions.

Core Features & Use Cases

• Structured Problem Description: Guides on clearly articulating the problem situation and its impact.
• Reproducible Steps: Ensures detailed, actionable steps for anyone to reproduce the issue.
• Solution Analysis: Encourages outlining proposed solutions and justifying the chosen approach, including rejected alternatives.
• Impact Assessment: Helps identify the scope of impact, aiding in prioritization and risk management.
• Use Case: A QA engineer discovers a bug and needs to create a comprehensive report for the development team.
• Use Case: A developer encounters an unexpected behavior in production and needs to document it for troubleshooting and resolution.

Quick Start

Draft an issue report for a bug where user login fails intermittently, including reproduction steps and potential causes.