Brand Guidelines
Write user-facing copy following Sentry's brand guidelines.
When to Use
- You need to write or rewrite user-facing copy in Sentry's voice.
- The task involves UI text, onboarding, empty states, docs, marketing copy, or other branded content.
- You need guidance on when to use Plain Speech versus Sentry Voice.
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
Limitations
- Use this skill only when the task clearly matches the scope described above.
- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.
1---2name: brand-guidelines-23description: 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---5
6# Brand Guidelines
7
8Write user-facing copy following Sentry's brand guidelines.
9
10## When to Use
11- You need to write or rewrite user-facing copy in Sentry's voice.
12- The task involves UI text, onboarding, empty states, docs, marketing copy, or other branded content.
13- You need guidance on when to use Plain Speech versus Sentry Voice.
14
15## Tone Selection
16
17Choose the appropriate tone based on context:
18
19| Use Plain Speech | Use Sentry Voice |
20|------------------|------------------|
21| Product UI (buttons, labels, forms) | 404 pages |
22| Documentation | Empty states |
23| Error messages | Onboarding flows |
24| Settings pages | Loading states |
25| Transactional emails | "What's New" announcements |
26| Help text | Marketing copy |
27
28**Default to Plain Speech** unless the context specifically calls for personality.
29
30## Plain Speech (Default)
31
32Plain Speech is clear, direct, and functional. Use it for most UI elements.
33
34### Rules
35
361. **Be concise** - Use the fewest words needed
372. **Be direct** - Tell users what to do, not what they can do
383. **Use active voice** - "Save your changes" not "Your changes will be saved"
394. **Avoid jargon** - Use simple words users understand
405. **Be specific** - "3 errors found" not "Some errors found"
41
42### Examples
43
44| Instead of | Write |
45|------------|-------|
46| "Click here to save your changes" | "Save" |
47| "You can filter results by date" | "Filter by date" |
48| "An error has occurred" | "Something went wrong" |
49| "Please enter a valid email address" | "Enter a valid email" |
50| "Are you sure you want to delete?" | "Delete this item?" |
51
52## Sentry Voice
53
54Sentry Voice adds personality in appropriate moments. It's empathetic, self-aware, and occasionally snarky.
55
56### Principles
57
581. **Empathetic snark** - Direct frustration at the situation, never the user
592. **Self-aware** - Acknowledge the absurdity of software
603. **Fun but functional** - Personality should enhance, not obscure meaning
614. **Earned moments** - Only use when users have time to appreciate it
62
63### Examples
64
65**404 Pages:**
66> "This page doesn't exist. Maybe it never did. Maybe it was a dream. Either way, let's get you back on track."
67
68**Empty States:**
69> "No errors yet. Enjoy this moment of peace while it lasts."
70
71**Onboarding:**
72> "Let's get your first error. Don't worry, it's not as scary as it sounds."
73
74**Loading States:**
75> "Crunching the numbers..."
76> "Fetching your data..."
77
78### When NOT to Use Sentry Voice
79
80- Error messages (users are frustrated)
81- Settings pages (users are focused)
82- Documentation (users need information)
83- Billing/payment flows (users need trust)
84
85## General Rules
86
87### Spelling and Grammar
88
89- Use **American English** spelling (color, not colour)
90- Use **Title Case** for headings and page titles
91- Use **Sentence case** for body text, buttons, and labels
92
93### Punctuation
94
95- **No exclamation marks** in UI text (exception: celebratory moments)
96- **No periods** in short UI labels or button text
97- **Use periods** in complete sentences and help text
98- **No ALL CAPS** except for acronyms (API, SDK, URL)
99
100### Word Choices
101
102| Avoid | Prefer |
103|-------|--------|
104| Please | (omit) |
105| Sorry | (be specific about the problem) |
106| Error occurred | Something went wrong |
107| Invalid | (explain what's wrong) |
108| Success! | (describe what happened) |
109| Oops | (be specific) |
110
111## Dash Usage
112
113| Type | Use | Example |
114|------|-----|---------|
115| Hyphen (-) | Compound words, ranges | "real-time", "1-10" |
116| En-dash (--) | Ranges, relationships | "2023--2024", "parent--child" |
117| Em-dash (---) | Interruption, emphasis | "Errors---even small ones---matter" |
118
119In most UI contexts, use hyphens. Reserve en-dashes for date ranges and em-dashes for longer prose.
120
121## UI Element Guidelines
122
123### Buttons
124
125- Use action verbs: "Save", "Delete", "Create"
126- Be specific: "Create Project" not just "Create"
127- Max 2-3 words when possible
128- No periods or exclamation marks
129
130### Error Messages
131
1321. Say what happened
1332. Say why (if helpful)
1343. Say what to do next
135
136**Good:** "Could not save changes. Check your connection and try again."
137**Bad:** "Error: Save failed."
138
139### Empty States
140
1411. Explain what would normally be here
1422. Provide a clear action to populate the state
1433. Sentry Voice is appropriate here
144
145**Good:** "No projects yet. Create your first project to start tracking errors."
146
147### Confirmation Dialogs
148
149- Make the action clear in the title
150- Explain consequences if destructive
151- Use specific button labels ("Delete Project", not "OK")
152
153### Tooltips and Help Text
154
155- Keep under 2 sentences
156- Explain the "why", not just the "what"
157- Link to docs for complex topics
158
159## Anti-Patterns
160
161Avoid these common mistakes:
162
163- **Robot speak:** "Item has been successfully deleted" -> "Deleted"
164- **Passive voice:** "Changes were saved" -> "Changes saved"
165- **Unnecessary words:** "In order to" -> "To"
166- **Hedging:** "This might cause..." -> "This will cause..."
167- **Double negatives:** "Not unlike..." -> "Similar to..."
168- **Marketing speak in UI:** "Supercharge your workflow" -> "Speed up your workflow"
169
170## References
171
172- [Sentry Voice Guidelines](https://develop.sentry.dev/frontend/sentry-voice/)
173- [Sentry Frontend Handbook](https://develop.sentry.dev/frontend/)
174
175## Limitations
176- Use this skill only when the task clearly matches the scope described above.
177- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
178- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.