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
根據每個問題的標題與描述內容,從 Sentry 工作區的標籤分類法中分類 Linear 問題,並套用對應的類型標籤。
official
sentry-flutter-sdk
sentry
完整的 Sentry SDK 設定,適用於 Flutter 和 Dart。當被要求「為 Flutter 加入 Sentry」、「安裝 sentry_flutter」、「在 Dart 中設定 Sentry」或設定錯誤…時使用。
official
sentry-svelte-sdk
sentry
完整的 Sentry SDK 設定,適用於 Svelte 和 SvelteKit。當被要求「將 Sentry 加入 Svelte」、「將 Sentry 加入 SvelteKit」、「安裝 @sentry/sveltekit」或進行設定時使用…
official
vercel-react-best-practices
sentry
來自 Vercel Engineering 的 React 與 Next.js 效能優化指南。此技能應在撰寫、審查或重構 React/Next.js… 時使用。
official
sentry-tanstack-start-sdk
sentry
完整的 Sentry SDK 設定,適用於 TanStack Start React。當被要求「將 Sentry 加入 TanStack Start」、「安裝 @sentry/tanstackstart-react」或設定錯誤…時使用。
official