# Error Message Design Sheet

Connect each error to its verified cause, user consequence, prevention, recovery action, preserved data, support path, and accessible implementation.

## Usage note

Write from the actual system state and tested recovery. Do not blame the user, expose sensitive diagnostics, promise data is safe without evidence, or offer a retry that repeats a harmful action.

## How to use this template

1. Record the trigger, distinguishable cause, completed actions, data state, and security boundary.
2. Define what the user needs to understand, correct, retry, preserve, or escalate.
3. Draft a clear problem statement, specific recovery, alternative, and safe support reference.
4. Trigger and test the error, repeat failure, and successful recovery in the implemented experience.
5. Monitor recurrence and assign product fixes instead of treating copy as permanent compensation.

## Blank template

### Error truth

- **Error ID and surface:** [Enter]
- **User action before error:** [Enter]
- **Trigger and known cause:** [Enter]
- **Causes intentionally indistinguishable:** [Enter]
- **What completed:** [Enter]
- **What failed:** [Enter]
- **Data, payment, or progress state:** [Verified]
- **Security or privacy detail to withhold:** [Enter]

### Message design

- **Heading:** [What could not happen]
- **Explanation:** [Impact without blame]
- **Primary recovery action:** [Exact label]
- **Expected result after action:** [Enter]
- **Alternative action:** [Enter]
- **Support path and safe reference:** [Enter]
- **Diagnostic code shown:** [Yes / No and reason]
- **Variable fallback:** [Enter]

### Prevention and behavior

- **Can the error be prevented earlier?:** [How]
- **Input preserved:** [Yes / No / Partly]
- **Retry safe and idempotent:** [Verified / Not verified]
- **Repeated failure behavior:** [Enter]
- **Offline or timeout distinction:** [Enter]
- **Session-expiry behavior:** [Enter]
- **Engineering owner:** [Name/team]
- **Support guidance:** [Reference]

### QA

- [ ] Error is announced and associated with the relevant control.
- [ ] Meaning does not depend on color, icon, or position.
- [ ] Raw diagnostics and sensitive identifiers are hidden.
- [ ] Recovery works with keyboard and relevant assistive technology.
- [ ] Long localized text and variable failures are handled.
- **Tester, build, and date:** [Enter]
- **Recurrence signal:** [Metric/support evidence]
- **Review trigger:** [Behavior, incident, support pattern]
