Brand Guidelines
Write user-facing copy following Sentry's brand guidelines.
Tone Selection
Choose the appropriate tone based on context:
| Use Plain Speech |
Use Sentry Voice |
| Product UI (buttons, labels, forms) |
404 pages |
| Documentation |
Empty states |
| Error messages |
Onboarding flows |
| Settings pages |
Loading states |
| Transactional emails |
"What's New" announcements |
| Help text |
Marketing copy |
Default to Plain Speech unless the context specifically calls for personality.
Plain Speech (Default)
Plain Speech is clear, direct, and functional. Use it for most UI elements.
Rules
- Be concise - Use the fewest words needed
- Be direct - Tell users what to do, not what they can do
- Use active voice - "Save your changes" not "Your changes will be saved"
- Avoid jargon - Use simple words users understand
- Be specific - "3 errors found" not "Some errors found"
Examples
| Instead of |
Write |
| "Click here to save your changes" |
"Save" |
| "You can filter results by date" |
"Filter by date" |
| "An error has occurred" |
"Something went wrong" |
| "Please enter a valid email address" |
"Enter a valid email" |
| "Are you sure you want to delete?" |
"Delete this item?" |
Sentry Voice
Sentry Voice adds personality in appropriate moments. It's empathetic, self-aware, and occasionally snarky.
Principles
- Empathetic snark - Direct frustration at the situation, never the user
- Self-aware - Acknowledge the absurdity of software
- Fun but functional - Personality should enhance, not obscure meaning
- Earned moments - Only use when users have time to appreciate it
Examples
404 Pages:
"This page doesn't exist. Maybe it never did. Maybe it was a dream. Either way, let's get you back on track."
Empty States:
"No errors yet. Enjoy this moment of peace while it lasts."
Onboarding:
"Let's get your first error. Don't worry, it's not as scary as it sounds."
Loading States:
"Crunching the numbers..."
"Fetching your data..."
When NOT to Use Sentry Voice
- Error messages (users are frustrated)
- Settings pages (users are focused)
- Documentation (users need information)
- Billing/payment flows (users need trust)
General Rules
Spelling and Grammar
- Use American English spelling (color, not colour)
- Use Title Case for headings and page titles
- Use Sentence case for body text, buttons, and labels
Punctuation
- No exclamation marks in UI text (exception: celebratory moments)
- No periods in short UI labels or button text
- Use periods in complete sentences and help text
- No ALL CAPS except for acronyms (API, SDK, URL)
Word Choices
| Avoid |
Prefer |
| Please |
(omit) |
| Sorry |
(be specific about the problem) |
| Error occurred |
Something went wrong |
| Invalid |
(explain what's wrong) |
| Success! |
(describe what happened) |
| Oops |
(be specific) |
Dash Usage
| Type |
Use |
Example |
| Hyphen (-) |
Compound words, ranges |
"real-time", "1-10" |
| En-dash (--) |
Ranges, relationships |
"2023--2024", "parent--child" |
| Em-dash (---) |
Interruption, emphasis |
"Errors---even small ones---matter" |
In most UI contexts, use hyphens. Reserve en-dashes for date ranges and em-dashes for longer prose.
UI Element Guidelines
Buttons
- Use action verbs: "Save", "Delete", "Create"
- Be specific: "Create Project" not just "Create"
- Max 2-3 words when possible
- No periods or exclamation marks
Error Messages
- Say what happened
- Say why (if helpful)
- Say what to do next
Good: "Could not save changes. Check your connection and try again."
Bad: "Error: Save failed."
Empty States
- Explain what would normally be here
- Provide a clear action to populate the state
- Sentry Voice is appropriate here
Good: "No projects yet. Create your first project to start tracking errors."
Confirmation Dialogs
- Make the action clear in the title
- Explain consequences if destructive
- Use specific button labels ("Delete Project", not "OK")
Tooltips and Help Text
- Keep under 2 sentences
- Explain the "why", not just the "what"
- Link to docs for complex topics
Anti-Patterns
Avoid these common mistakes:
- Robot speak: "Item has been successfully deleted" -> "Deleted"
- Passive voice: "Changes were saved" -> "Changes saved"
- Unnecessary words: "In order to" -> "To"
- Hedging: "This might cause..." -> "This will cause..."
- Double negatives: "Not unlike..." -> "Similar to..."
- Marketing speak in UI: "Supercharge your workflow" -> "Speed up your workflow"
References
1---2name: brand-guidelines3description: Write copy following Sentry brand guidelines. Use when writing UI text, error messages, empty states, onboarding flows, 404 pages, documentation, marketing copy, or any user-facing content. Covers both Plain Speech (default) and Sentry Voice tones.4---56# Brand Guidelines78Write user-facing copy following Sentry's brand guidelines.910## Tone Selection1112Choose the appropriate tone based on context:1314| Use Plain Speech | Use Sentry Voice |15|------------------|------------------|16| Product UI (buttons, labels, forms) | 404 pages |17| Documentation | Empty states |18| Error messages | Onboarding flows |19| Settings pages | Loading states |20| Transactional emails | "What's New" announcements |21| Help text | Marketing copy |2223**Default to Plain Speech** unless the context specifically calls for personality.2425## Plain Speech (Default)2627Plain Speech is clear, direct, and functional. Use it for most UI elements.2829### Rules30311. **Be concise** - Use the fewest words needed322. **Be direct** - Tell users what to do, not what they can do333. **Use active voice** - "Save your changes" not "Your changes will be saved"344. **Avoid jargon** - Use simple words users understand355. **Be specific** - "3 errors found" not "Some errors found"3637### Examples3839| Instead of | Write |40|------------|-------|41| "Click here to save your changes" | "Save" |42| "You can filter results by date" | "Filter by date" |43| "An error has occurred" | "Something went wrong" |44| "Please enter a valid email address" | "Enter a valid email" |45| "Are you sure you want to delete?" | "Delete this item?" |4647## Sentry Voice4849Sentry Voice adds personality in appropriate moments. It's empathetic, self-aware, and occasionally snarky.5051### Principles52531. **Empathetic snark** - Direct frustration at the situation, never the user542. **Self-aware** - Acknowledge the absurdity of software553. **Fun but functional** - Personality should enhance, not obscure meaning564. **Earned moments** - Only use when users have time to appreciate it5758### Examples5960**404 Pages:**61> "This page doesn't exist. Maybe it never did. Maybe it was a dream. Either way, let's get you back on track."6263**Empty States:**64> "No errors yet. Enjoy this moment of peace while it lasts."6566**Onboarding:**67> "Let's get your first error. Don't worry, it's not as scary as it sounds."6869**Loading States:**70> "Crunching the numbers..."71> "Fetching your data..."7273### When NOT to Use Sentry Voice7475- Error messages (users are frustrated)76- Settings pages (users are focused)77- Documentation (users need information)78- Billing/payment flows (users need trust)7980## General Rules8182### Spelling and Grammar8384- Use **American English** spelling (color, not colour)85- Use **Title Case** for headings and page titles86- Use **Sentence case** for body text, buttons, and labels8788### Punctuation8990- **No exclamation marks** in UI text (exception: celebratory moments)91- **No periods** in short UI labels or button text92- **Use periods** in complete sentences and help text93- **No ALL CAPS** except for acronyms (API, SDK, URL)9495### Word Choices9697| Avoid | Prefer |98|-------|--------|99| Please | (omit) |100| Sorry | (be specific about the problem) |101| Error occurred | Something went wrong |102| Invalid | (explain what's wrong) |103| Success! | (describe what happened) |104| Oops | (be specific) |105106## Dash Usage107108| Type | Use | Example |109|------|-----|---------|110| Hyphen (-) | Compound words, ranges | "real-time", "1-10" |111| En-dash (--) | Ranges, relationships | "2023--2024", "parent--child" |112| Em-dash (---) | Interruption, emphasis | "Errors---even small ones---matter" |113114In most UI contexts, use hyphens. Reserve en-dashes for date ranges and em-dashes for longer prose.115116## UI Element Guidelines117118### Buttons119120- Use action verbs: "Save", "Delete", "Create"121- Be specific: "Create Project" not just "Create"122- Max 2-3 words when possible123- No periods or exclamation marks124125### Error Messages1261271. Say what happened1282. Say why (if helpful)1293. Say what to do next130131**Good:** "Could not save changes. Check your connection and try again."132**Bad:** "Error: Save failed."133134### Empty States1351361. Explain what would normally be here1372. Provide a clear action to populate the state1383. Sentry Voice is appropriate here139140**Good:** "No projects yet. Create your first project to start tracking errors."141142### Confirmation Dialogs143144- Make the action clear in the title145- Explain consequences if destructive146- Use specific button labels ("Delete Project", not "OK")147148### Tooltips and Help Text149150- Keep under 2 sentences151- Explain the "why", not just the "what"152- Link to docs for complex topics153154## Anti-Patterns155156Avoid these common mistakes:157158- **Robot speak:** "Item has been successfully deleted" -> "Deleted"159- **Passive voice:** "Changes were saved" -> "Changes saved"160- **Unnecessary words:** "In order to" -> "To"161- **Hedging:** "This might cause..." -> "This will cause..."162- **Double negatives:** "Not unlike..." -> "Similar to..."163- **Marketing speak in UI:** "Supercharge your workflow" -> "Speed up your workflow"164165## References166167- [Sentry Voice Guidelines](https://develop.sentry.dev/frontend/sentry-voice/)168- [Sentry Frontend Handbook](https://develop.sentry.dev/frontend/)