When reporting an issue make sure to use concise, descriptive summary that quickly informs the reader of the problem, its location, and its impact. The goal is to provide enough information so the issue can be understood and prioritized without needing the full details of the report.
Key Features
- Clear and Concise: It should be a short, single-line text input or title, typically less than 100 characters.
- Descriptive: It should use specific keywords to describe exactly what the report is about, avoiding vague terms like "Software fails" or "install problem".
- Actionable: It allows the person reviewing it (e.g., a project manager or developer) to quickly understand the core problem and which department might need to address it.