Skip to content

Maintenance Priority: {{MAINTENANCE_AREA_NAME}}

Priority: {{PRIORITY}} (P0/P1/P2/P3) Status: Active Last Updated: {{DATE}}

Priority Justification

{{Why this maintenance area is important and why it needs attention now}}

Scope

Affected Modules/Components: - {{MODULE_1}} - {{MODULE_2}} - {{MODULE_3}}

Affected Files/Directories: - {{FILE_PATH_1}} - {{FILE_PATH_2}} - {{DIRECTORY_PATH}}/

Guidelines

Requirements

{{Specific requirements that need to be met in this maintenance area}}

  1. {{REQUIREMENT_1}}
  2. {{REQUIREMENT_2}}
  3. {{REQUIREMENT_3}}

Standards

{{Standards or best practices to follow}}

  • {{STANDARD_1}}
  • {{STANDARD_2}}
  • {{STANDARD_3}}

Constraints

{{Any constraints or limitations to be aware of}}

  • {{CONSTRAINT_1}}
  • {{CONSTRAINT_2}}

Success Criteria

The work in this maintenance area is considered complete when:

  • {{SUCCESS_CRITERION_1}}
  • {{SUCCESS_CRITERION_2}}
  • {{SUCCESS_CRITERION_3}}
  • {{SUCCESS_CRITERION_4}}

Target Metrics (if applicable): - {{METRIC_1}}: Current {{CURRENT_VALUE}}, Target {{TARGET_VALUE}} - {{METRIC_2}}: Current {{CURRENT_VALUE}}, Target {{TARGET_VALUE}}

Example Tasks

These are examples of the types of tasks that fall under this maintenance priority:

  1. {{EXAMPLE_TASK_1}}
  2. {{EXAMPLE_TASK_2}}
  3. {{EXAMPLE_TASK_3}}
  4. {{EXAMPLE_TASK_4}}

Context

Current State

{{Description of the current state and why it needs improvement}}

Desired State

{{Description of what the ideal state looks like}}

Impact

{{Impact of completing this maintenance work}}

  • User Impact: {{USER_IMPACT}}
  • Developer Impact: {{DEVELOPER_IMPACT}}
  • System Impact: {{SYSTEM_IMPACT}}

References

  • Related Architecture Decisions: {{ADR_LINKS}}
  • Related Documentation: {{DOC_LINKS}}
  • Related Issues: {{ISSUE_LINKS}}
  • External Resources: {{EXTERNAL_LINKS}}

Notes

{{Any additional notes, considerations, or context}}

Instructions for ADW Workflow: When generating issues from this guideline: 1. Review the current state of the modules in scope 2. Identify specific gaps or improvements needed 3. Create focused issues that can be completed in ~100 LOC 4. Reference this guideline file in the issue description 5. Apply appropriate labels: maintenance, priority:{{PRIORITY}}, and category labels