What problem does it solve?
This framework provides a structured approach to evaluate and improve how a codebase handles errors, focusing on debuggability, user experience, and resilience during failures.
Core Features & Use Cases
- Guided error capture and propagation criteria: assess where errors are caught, preserved context, and how failures are surfaced.
- Error types, codes, and consistency: review the taxonomy of errors and ensure uniform handling across modules.
- User-facing messages and API responses: ensure messages are actionable, non-technical for users, and include actionable details for developers.
- Observability and logging guidance: prescribe structured logs, correlation IDs, and appropriate log levels to trace failures.
- Recovery patterns and testability: define retry, fallback, and circuit-breaker strategies; enable verifiable test coverage.
- Use Case examples: apply the framework to audits of REST APIs, UI components, and background jobs to demonstrate improvements.
Quick Start
Use this framework to initiate an error-handling audit on your project by following these steps:
- Step 1: Map error boundaries across frontend, backend, and services.
- Step 2: Apply the framework's criteria to identify gaps in error capture, messages, logging, and recovery.
- Step 3: Document findings in a structured report and implement recommended changes, then re-audit.
