Editorial draft available to read. Factual and language review is pending. Examples are illustrative.
Decision and scope
Group errors by the business situation and the action that resolves it. Each catalogue entry needs a stable code, a plain explanation, affected information and an accountable owner. Distinguish invalid input, incompatible record state, missing authority and a temporary service failure because their recovery paths are different.
Illustrative example
Illustrative example: an order cannot close because delivery confirmation is missing. The message identifies the required confirmation and links to an action the user is allowed to perform. It does not merely display a generic failure that forces support to reconstruct the entire workflow from the beginning.
Acceptance check
Test consistent behavior through the interface and integrations. Avoid exposing unnecessary internal details in public messages. Accept the catalogue when users understand what they can correct and support can locate the same event through a shared reference.
Key takeaways
- Accept the catalogue when users understand what they can correct and support can locate the same event through a shared reference.