Technical Debt Management

Technical Debt Management

Skill Profile

(Select at least one profile to enable specific modules)

• DevOps
• Backend
• Frontend
• AI-RAG
• Security Critical

Overview

Technical debt is the implied cost of additional rework caused by choosing an easy solution now instead of using a better approach that would take longer. This skill provides frameworks for identifying, classifying, quantifying, and managing technical debt to maintain code quality, team velocity, and system health. It enables teams to balance short-term delivery speed with long-term maintainability through systematic debt tracking and repayment.

Why This Matters

• Increases Development Velocity: Reducing technical debt prevents accumulated complexity that slows down future feature development
• Reduces Maintenance Burden: Systematic debt management prevents endless cycles of fixing the same problems repeatedly
• Enables Informed Decision-Making: Understanding the cost of shortcuts helps teams make better trade-offs between speed and quality
• Improves Code Quality: Debt repayment and prevention strategies directly improve codebase health and readability
• Enhances Team Morale: Reducing frustrating workarounds and legacy systems improves developer satisfaction and productivity

Core Concepts & Rules

1. Core Principles

• Follow established patterns and conventions
• Maintain consistency across codebase
• Document decisions and trade-offs

2. Implementation Guidelines

• Start with the simplest viable solution
• Iterate based on feedback and requirements
• Test thoroughly before deployment

Inputs / Outputs / Contracts

• Inputs:
  • Codebase analysis results
  • Code review feedback
  • Architectural review findings
  • Team-reported debt items
  • Performance and stability metrics
• Entry Conditions:
  • Codebase is accessible
  • Code analysis tools are configured
  • Team is trained on debt identification
• Outputs:
  • Debt register with all identified items
  • Debt classification by type and severity
  • Quantified debt metrics (effort, interest, risk)
  • Prioritized repayment plan
  • Prevention strategies and processes
• Artifacts Required (Deliverables):
  • Debt register document
  • Debt analysis report
  • Repayment plan with timeline
  • Prevention process documentation
• Acceptance Evidence:
  • Debt register is complete and accessible
  • Repayment capacity is allocated
  • Prevention processes are implemented
  • Team is trained on debt management
• Success Criteria:
  • Debt is tracked and visible
  • Repayment capacity is allocated
  • Debt reduction metrics are improving
  • Team velocity is maintained or improved

Skill Composition

• Depends on: architectural-reviews, code-review
• Compatible with: refactoring-strategies, system-thinking
• Conflicts with: None
• Related Skills: risk-assessment, decision-records

Quick Start / Implementation Example

1. Review requirements and constraints
2. Set up development environment
3. Implement core functionality following patterns
4. Write tests for critical paths
5. Run tests and fix issues
6. Document any deviations or decisions

# Example implementation following best practices
def example_function():
    # Your implementation here
    pass

Assumptions / Constraints / Non-goals

• Assumptions:
  • Development environment is properly configured
  • Required dependencies are available
  • Team has basic understanding of domain
• Constraints:
  • Must follow existing codebase conventions
  • Time and resource limitations
  • Compatibility requirements
• Non-goals:
  • This skill does not cover edge cases outside scope
  • Not a replacement for formal training

Compatibility & Prerequisites

• Supported Versions:
  • Python 3.8+
  • Node.js 16+
  • Modern browsers (Chrome, Firefox, Safari, Edge)
• Required AI Tools:
  • Code editor (VS Code recommended)
  • Testing framework appropriate for language
  • Version control (Git)
• Dependencies:
  • Language-specific package manager
  • Build tools
  • Testing libraries
• Environment Setup:
  • .env.example keys: API_KEY, DATABASE_URL (no values)

Test Scenario Matrix (QA Strategy)

Technical Guardrails & Security Threat Model

1. Security & Privacy (Threat Model)

• Top Threats: Injection attacks, authentication bypass, data exposure

• Data Handling: Sanitize all user inputs to prevent Injection attacks. Never log raw PII
• Secrets Management: No hardcoded API keys. Use Env Vars/Secrets Manager
• Authorization: Validate user permissions before state changes

2. Performance & Resources

• Execution Efficiency: Consider time complexity for algorithms
• Memory Management: Use streams/pagination for large data
• Resource Cleanup: Close DB connections/file handlers in finally blocks

3. Architecture & Scalability

• Design Pattern: Follow SOLID principles, use Dependency Injection
• Modularity: Decouple logic from UI/Frameworks

4. Observability & Reliability

• Logging Standards: Structured JSON, include trace IDs request_id
• Metrics: Track error_rate, latency, queue_depth
• Error Handling: Standardized error codes, no bare except
• Observability Artifacts:
  • Log Fields: timestamp, level, message, request_id
  • Metrics: request_count, error_count, response_time
  • Dashboards/Alerts: High Error Rate > 5%

Agent Directives & Error Recovery

(ข้อกำหนดสำหรับ AI Agent ในการคิดและแก้ปัญหาเมื่อเกิดข้อผิดพลาด)

• Thinking Process: Analyze root cause before fixing. Do not brute-force.
• Fallback Strategy: Stop after 3 failed test attempts. Output root cause and ask for human intervention/clarification.
• Self-Review: Check against Guardrails & Anti-patterns before finalizing.
• Output Constraints: Output ONLY the modified code block. Do not explain unless asked.

Definition of Done (DoD) Checklist

• Tests passed + coverage met
• Lint/Typecheck passed
• Logging/Metrics/Trace implemented
• Security checks passed
• Documentation/Changelog updated
• Accessibility/Performance requirements met (if frontend)

Anti-patterns / Pitfalls

• ⛔ Don't: Log PII, catch-all exception, N+1 queries
• ⚠️ Watch out for: Common symptoms and quick fixes
• 💡 Instead: Use proper error handling, pagination, and logging

Reference Links & Examples

• Internal documentation and examples
• Official documentation and best practices
• Community resources and discussions

Versioning & Changelog

• Version: 1.0.0
• Changelog:
  • 2026-02-22: Initial version with complete template structure

Converted and distributed by TomeVault — claim your Tome and manage your conversions.