| name | issue-documentation |
| description | Provides standardized templates and guidelines for comprehensive issue documentation. Systematically documents problem situations, reproduction steps, root causes, solutions, and impact scope. Ensures clear communication through structured bug reports, troubleshooting documentation, and incident tracking. Implements best practices for GitHub Issues, Linear, Jira, and other issue tracking systems. Use when: creating bug reports, writing GitHub/Linear/Jira issues, documenting problem situations and symptoms, providing step-by-step reproduction instructions, analyzing root causes, documenting solutions and workarounds, assessing impact scope and severity, tracking incident timelines, or creating troubleshooting guides for known issues. |
Issue Documentation Guide
Basic Principles
- Concise and clear
- With actionable examples
- Focus on the "why"
Issue
Problem Situation
What is the specific problem?
Reproduction Method (only for issues that need and can be reproduced):
- Step 1
- Step 2
- Expected result vs. actual result
Attach related code location or screenshots
Solution
[Selected approach]
Write specific resolution method and reason for adoption
Reviewed but Rejected Approaches (if any)
- Approach A: Reason for rejection
- Approach B: Reason for rejection
Impact Scope (if any)
- Affected parts