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.4metadata:5 source: https://skillmd.com/skills/comeonoliver/brand-guidelines6---78# Brand Guidelines910Write user-facing copy following Sentry's brand guidelines.1112## Tone Selection1314Choose the appropriate tone based on context:1516| Use Plain Speech | Use Sentry Voice |17|------------------|------------------|18| Product UI (buttons, labels, forms) | 404 pages |19| Documentation | Empty states |20| Error messages | Onboarding flows |21| Settings pages | Loading states |22| Transactional emails | "What's New" announcements |23| Help text | Marketing copy |2425**Default to Plain Speech** unless the context specifically calls for personality.2627## Plain Speech (Default)2829Plain Speech is clear, direct, and functional. Use it for most UI elements.3031### Rules32331. **Be concise** - Use the fewest words needed342. **Be direct** - Tell users what to do, not what they can do353. **Use active voice** - "Save your changes" not "Your changes will be saved"364. **Avoid jargon** - Use simple words users understand375. **Be specific** - "3 errors found" not "Some errors found"3839### Examples4041| Instead of | Write |42|------------|-------|43| "Click here to save your changes" | "Save" |44| "You can filter results by date" | "Filter by date" |45| "An error has occurred" | "Something went wrong" |46| "Please enter a valid email address" | "Enter a valid email" |47| "Are you sure you want to delete?" | "Delete this item?" |4849## Sentry Voice5051Sentry Voice adds personality in appropriate moments. It's empathetic, self-aware, and occasionally snarky.5253### Principles54551. **Empathetic snark** - Direct frustration at the situation, never the user562. **Self-aware** - Acknowledge the absurdity of software573. **Fun but functional** - Personality should enhance, not obscure meaning584. **Earned moments** - Only use when users have time to appreciate it5960### Examples6162**404 Pages:**63> "This page doesn't exist. Maybe it never did. Maybe it was a dream. Either way, let's get you back on track."6465**Empty States:**66> "No errors yet. Enjoy this moment of peace while it lasts."6768**Onboarding:**69> "Let's get your first error. Don't worry, it's not as scary as it sounds."7071**Loading States:**72> "Crunching the numbers..."73> "Fetching your data..."7475### When NOT to Use Sentry Voice7677- Error messages (users are frustrated)78- Settings pages (users are focused)79- Documentation (users need information)80- Billing/payment flows (users need trust)8182## General Rules8384### Spelling and Grammar8586- Use **American English** spelling (color, not colour)87- Use **Title Case** for headings and page titles88- Use **Sentence case** for body text, buttons, and labels8990### Punctuation9192- **No exclamation marks** in UI text (exception: celebratory moments)93- **No periods** in short UI labels or button text94- **Use periods** in complete sentences and help text95- **No ALL CAPS** except for acronyms (API, SDK, URL)9697### Word Choices9899| Avoid | Prefer |100|-------|--------|101| Please | (omit) |102| Sorry | (be specific about the problem) |103| Error occurred | Something went wrong |104| Invalid | (explain what's wrong) |105| Success! | (describe what happened) |106| Oops | (be specific) |107108## Dash Usage109110| Type | Use | Example |111|------|-----|---------|112| Hyphen (-) | Compound words, ranges | "real-time", "1-10" |113| En-dash (--) | Ranges, relationships | "2023--2024", "parent--child" |114| Em-dash (---) | Interruption, emphasis | "Errors---even small ones---matter" |115116In most UI contexts, use hyphens. Reserve en-dashes for date ranges and em-dashes for longer prose.117118## UI Element Guidelines119120### Buttons121122- Use action verbs: "Save", "Delete", "Create"123- Be specific: "Create Project" not just "Create"124- Max 2-3 words when possible125- No periods or exclamation marks126127### Error Messages1281291. Say what happened1302. Say why (if helpful)1313. Say what to do next132133**Good:** "Could not save changes. Check your connection and try again."134**Bad:** "Error: Save failed."135136### Empty States1371381. Explain what would normally be here1392. Provide a clear action to populate the state1403. Sentry Voice is appropriate here141142**Good:** "No projects yet. Create your first project to start tracking errors."143144### Confirmation Dialogs145146- Make the action clear in the title147- Explain consequences if destructive148- Use specific button labels ("Delete Project", not "OK")149150### Tooltips and Help Text151152- Keep under 2 sentences153- Explain the "why", not just the "what"154- Link to docs for complex topics155156## Anti-Patterns157158Avoid these common mistakes:159160- **Robot speak:** "Item has been successfully deleted" -> "Deleted"161- **Passive voice:** "Changes were saved" -> "Changes saved"162- **Unnecessary words:** "In order to" -> "To"163- **Hedging:** "This might cause..." -> "This will cause..."164- **Double negatives:** "Not unlike..." -> "Similar to..."165- **Marketing speak in UI:** "Supercharge your workflow" -> "Speed up your workflow"166167## References168169- [Sentry Voice Guidelines](https://develop.sentry.dev/frontend/sentry-voice/)170- [Sentry Frontend Handbook](https://develop.sentry.dev/frontend/)171