Index of every page on this site: llms.txt
All skills
getsentry avatar

/brand-guidelines

@a582c51 official
by Sentrygetsentry/skills1.2k stars
71
Run it yourself

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.

Use this Skill: https://skilld.dev/gh/getsentry/skills/brand-guidelines

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈67 tokens for metadata: the name and description. ≈1.2k when used: this file.

Description uses 3.3% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈267 characters, or 3.3%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

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

  1. Be concise - Use the fewest words needed
  2. Be direct - Tell users what to do, not what they can do
  3. Use active voice - "Save your changes" not "Your changes will be saved"
  4. Avoid jargon - Use simple words users understand
  5. 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

  1. Empathetic snark - Direct frustration at the situation, never the user
  2. Self-aware - Acknowledge the absurdity of software
  3. Fun but functional - Personality should enhance, not obscure meaning
  4. 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

  1. Say what happened
  2. Say why (if helpful)
  3. Say what to do next

Good: "Could not save changes. Check your connection and try again." Bad: "Error: Save failed."

Empty States

  1. Explain what would normally be here
  2. Provide a clear action to populate the state
  3. 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

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No alerts2mo5 checks · Risk SAFE
  • Gen Agent Trust Hub2mo

    This skill provides content style guidelines for Sentry, covering tone selection, grammar, punctuation, and UI copy patterns without any executable code or risky behaviors.

  • Socket2mo

    No alerts

  • Snyk2mo

    Risk: LOW · No issues

  • Runlayer9mo

    1 file scanned · No issues

  • ZeroLeaks7mo

    Score: 93/100 · 2 sections analyzed

Signed by skilld at a582c51. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 6 days ago.

Activeupdated 7 months ago
  • Documentation
  • sentry
  • brand-guidelines
  • copy-writing
  • ui-text
  • tone-of-voice
  • error-messages
  • content-strategy

README badge

README badge for getsentry/skills/brand-guidelines

Instructs an AI agent on Sentry's brand guidelines for writing user-facing copy, covering two tones: Plain Speech (default for UI, documentation, error messages) and Sentry Voice (for 404 pages, empty states, onboarding). Includes specific rules for grammar, punctuation, button labels, error messages, and anti-patterns to avoid.

Generated from the current SKILL.md.

When should I use Sentry Voice versus Plain Speech?
Default to Plain Speech for product UI, documentation, error messages, and settings. Use Sentry Voice only for 404 pages, empty states, onboarding flows, loading states, and marketing copy—contexts where users have time to appreciate personality.
Can I use exclamation marks and snarky tone in error messages?
No. Error messages should use Plain Speech and avoid exclamation marks because users are already frustrated. Save Sentry Voice for moments like empty states and 404 pages where it won't add to user frustration.
What's the difference between how I should write buttons versus help text?
Buttons use action verbs in 2-3 words with no periods ('Save', 'Create Project'). Help text can be up to 2 sentences and should explain the 'why' behind a feature, using periods and complete sentences.
Does this skill cover specific products or just general Sentry guidelines?
This skill covers Sentry's general brand and tone guidelines for any user-facing copy. It applies across Sentry's product UI, documentation, and marketing materials rather than a single specific feature.

Generated from the current SKILL.md. These answers refresh after source changes.