brand-guidelines

作者: sentry

根据Sentry品牌指南撰写文案。适用于UI文本、错误消息、空状态、引导流程、404页面、文档、营销等场景。

npx skills add https://github.com/getsentry/skills --skill brand-guidelines

Brand Guidelines

Write user-facing copy following Sentry's brand guidelines.

Tone Selection

Choose the appropriate tone based on context:

Use Plain SpeechUse Sentry Voice
Product UI (buttons, labels, forms)404 pages
DocumentationEmpty states
Error messagesOnboarding flows
Settings pagesLoading states
Transactional emails"What's New" announcements
Help textMarketing 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 ofWrite
"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

AvoidPrefer
Please(omit)
Sorry(be specific about the problem)
Error occurredSomething went wrong
Invalid(explain what's wrong)
Success!(describe what happened)
Oops(be specific)

Dash Usage

TypeUseExample
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

来自 sentry 的更多技能

generate-frontend-forms
sentry
使用Sentry新表单系统创建表单的指南。在实现表单、表单字段、验证或自动保存功能时使用。
official
sentry-snapshots-cocoa
sentry
完整的 Sentry Snapshots 配置,适用于 Apple/Cocoa 项目。当被要求“设置 SnapshotPreviews”、“设置 Apple 快照测试”、“上传 Apple 快照到…”时使用。
official
architecture-review
sentry
员工级代码库健康审查。发现单体模块、静默失败、类型安全漏洞、测试覆盖缺口以及LLM友好性问题。
official
linear-type-labeler
sentry
根据每个问题的标题和描述内容,对Linear问题进行分类,并从Sentry工作区的标签分类体系中应用一个类型标签。
official
sentry-flutter-sdk
sentry
完整的Sentry SDK配置,适用于Flutter和Dart。当被要求“为Flutter添加Sentry”、“安装sentry_flutter”、“在Dart中配置Sentry”或配置错误…时使用。
official
sentry-svelte-sdk
sentry
为Svelte和SvelteKit提供完整的Sentry SDK设置。当被要求“为Svelte添加Sentry”、“为SvelteKit添加Sentry”、“安装@sentry/sveltekit”或配置……时使用。
official
vercel-react-best-practices
sentry
来自 Vercel 工程团队的 React 和 Next.js 性能优化指南。在编写、审查或重构 React/Next.js… 时应使用此技能。
official
sentry-tanstack-start-sdk
sentry
为TanStack Start React提供完整的Sentry SDK设置。当被要求“向TanStack Start添加Sentry”、“安装@sentry/tanstackstart-react”或配置错误…时使用。
official