Error Message Writing Guide

J

Jordan Reyes

@jordan-reyes

·

Create clear and helpful error messages for better user experience

15 copies0 forks
Write user-friendly error messages for {{feature_or_system}}.

Error scenarios: {{scenarios}}
User context: {{context}}
Tone: {{tone}}

**Error Message Framework:**

**1. Error Categories**

*User Errors*
- Invalid input
- Missing information
- Permissions issues

*System Errors*
- Server failures
- Timeout issues
- Integration failures

*State Errors*
- Conflicting operations
- Stale data
- Session issues

**2. Message Structure**

For each error:
- **What happened** (clear, specific)
- **Why it happened** (if helpful)
- **What to do next** (actionable)

**3. Writing Principles**

*Do*
- Use plain language
- Be specific about the problem
- Offer a solution or next step
- Take responsibility (system errors)
- Be brief but complete

*Do Not*
- Use technical jargon
- Blame the user
- Use negative language
- Leave user stranded
- Be vague

**4. Error Messages**

For each scenario:
| Scenario | Error Code | User Message | Action Offered |

**5. Edge Cases**
- Offline states
- Unknown errors
- Multiple errors
- Recoverable vs non-recoverable

**6. Logging Considerations**
- What to log (for debugging)
- What not to expose (security)

Details

Category

Productivity

Use Cases

UX writingError handlingProduct polish

Works Best With

gpt-4claude-3
Created Updated Shared

Create your own prompt vault and start sharing

Error Message Writing Guide | Promptsy