| name | issue-documentation |
| description | Standard template and guide for issue documentation. Systematically document problem situation, reproduction method, solution, and impact scope. TRIGGER: Bug report, issue writing, problem situation documentation, troubleshooting documentation, bug tracking, GitHub/Linear issue creation |
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