#Defects Best Practices & Use Cases
Defects are most effective when they provide clear context, accurate impact, and strong traceability. This guide outlines best practices to help teams manage defects consistently and efficiently in Hawzu.
#Writing High-Quality Defects
#Use Clear and Actionable Titles
A good defect title should:
- Describe the problem, not the solution
- Be concise and specific
- Avoid vague phrases like “doesn’t work” or “issue found”
Good examples:
- “Save button remains disabled after form validation”
- “Calendar event not created when timezone is UTC+0”
#Provide Reproducible Descriptions
Defect descriptions should help anyone understand and reproduce the issue.
Recommended structure:
- Brief summary of the issue
- Steps to reproduce
- Actual behavior
- Expected behavior (if applicable)
When defects are created from test executions, Hawzu automatically:
- Consolidates executed steps into the description
- Preserves rich formatting
- Excludes media to keep content clean and readable
Review and adjust the description if additional context is required.
#Priority & Severity Best Practices
- Priority: How urgently the defect should be fixed
- Severity: The impact of the defect on the system or users
Hawzu automatically pre-fills priority and severity from the test case during execution-based defect creation. This ensures consistency and reduces manual errors.
Best Practice:
- Review auto-filled values
- Adjust only when the real-world impact differs from test expectations
#Execution-Based Defect Creation
#Create Defects from Test Executions
Whenever possible, create defects directly from failed test cases.
Benefits:
- Automatic linking to executions and releases
- Accurate reproduction context
- Reduced manual effort
- Strong audit trail
Hawzu automatically:
- Links the defect to the execution and release
- Copies test case priority and severity
- Builds a structured description from executed steps
#Link Existing Defects When Applicable
Before creating a new defect:
- Search for existing related defects
- Link instead of duplicating
This helps:
- Avoid duplicate work
- Maintain clean defect history
- Improve reporting accuracy
#Traceability Best Practices
Defects should be traceable to:
- Test cases
- Executions
- Releases
- Requirements (when applicable)
Traceability helps teams:
- Understand impact scope
- Identify regression risks
- Improve root cause analysis
Always verify traceability when creating or reviewing defects.
#Assignment & Ownership
Unassigned defects often get delayed.
Best practices:
- Assign defects during creation or triage
- Use due dates for time-sensitive issues
- Reassign promptly if ownership changes
Clear ownership ensures accountability and faster resolution.
#Collaboration & Updates
Comments should be used to:
- Share investigation findings
- Ask clarifying questions
- Record decisions or workarounds
- Provide status updates
Avoid duplicating execution steps or descriptions in comments.
#Keep Status Up to Date
Regularly update defect status to reflect reality:
- Move to In Progress when work starts
- Use Resolved only when a fix is ready
- Transition to Verified after successful validation
Accurate statuses improve visibility and reporting.
#External Integrations Best Practices
When integrating with tools like Jira, GitHub, GitLab, or Azure DevOps:
- Create or link external issues intentionally
- Keep Hawzu as the primary reference
- Use external tools for engineering workflows, not duplicate tracking
This prevents sync conflicts and ensures consistent reporting.
#Common Use Cases
#Defects During Test Execution
- Test case fails during execution
- Create defect directly from execution
- Hawzu auto-fills context and traceability
- Assign to the appropriate owner
- Track resolution through lifecycle
#Release Blocking Defects
- Identify high-severity or high-priority defects
- Ensure release linkage is present
- Monitor status closely during release cycles
- Validate fixes before closing the release
#Regression Issues
- Link defect to related test cases and executions
- Use history to track reopens
- Ensure test coverage is updated to prevent recurrence
#Common Pitfalls to Avoid
- Creating defects without execution context
- Leaving defects unassigned
- Overusing high priority or severity
- Duplicating existing defects
- Ignoring traceability links
#Final Recommendations
- Prefer execution-based defect creation
- Trust auto-filled data, but verify when needed
- Keep descriptions structured and focused
- Maintain ownership and traceability
- Use comments for collaboration, not repetition
Well-managed defects lead to faster fixes, clearer communication, and higher software quality.
#Next Steps