~linuxgoose/engineering-templates

engineering-templates/templates/technical-debt-registry.md -rw-r--r-- 1.7 KiB
f290fa18Jordan Robinson add tips / help section 3 months ago

#Technical Debt Registry

#Debt Entry: [DEBT-XXX]

Title: [Brief description]
Component: [Affected service/module]
Created: [Date]
Created By: [Name]
Status: [Active/In Progress/Resolved/Deferred]
Priority: [Critical/High/Medium/Low]

#Description

What is the technical debt? What shortcut was taken or compromise made?

#Context & Rationale

Why was this debt incurred? What were the circumstances?

  • Business pressures (time-to-market, resources, etc.)
  • Technical constraints at the time
  • Stakeholder decisions

#Current Impact

#Development Impact

  • How does it slow down development?
  • Which features are affected?
  • Estimated time cost per change

#Operational Impact

  • Does it affect reliability?
  • Does it impact performance?
  • Monitoring/troubleshooting overhead

#User Impact

  • Does it affect user experience?
  • Any customer complaints?
  • Performance implications for users

#Repayment Plan

#Proposed Solution

How would this debt be addressed in an ideal scenario?

#Effort Estimate

  • Estimated story points or days
  • Recommended team size
  • Dependencies that must be resolved first

#Timeline

  • When should this be addressed?
  • Blocking any planned work?
  • Can be deferred to next quarter? (Yes/No and why)

#Success Criteria

  • How will we know it's fixed?
  • Metrics to validate
  • Testing requirements

#Risk of Not Addressing

  • What happens if we never fix this?
  • Long-term consequences
  • Escalation probability
  • Links to related debt items
  • Potential cascade effects
  • Blockers for other work

#Owner & Tracking

  • Currently owned by: [Team/Person]
  • Jira/issue tracker link: [Link]
  • Next review date: [Date]