关于
按照 Sentry 品牌指南撰写文案。适用于编写 UI 文本、错误消息、空状态、引导流程、404 页面、文档、营销文案或任何面向用户的内容。
name: brand-guidelines description: 按照 Sentry 品牌指南撰写文案。适用于编写 UI 文本、错误消息、空状态、引导流程、404 页面、文档、营销文案或任何面向用户的内容。涵盖 Plain Speech（默认）和 Sentry Voice 两种语调。 risk: unknown source: community
品牌指南
按照 Sentry 的品牌指南撰写面向用户的文案。
使用场景
- 你需要用 Sentry 的语调撰写或改写面向用户的文案。
- 任务涉及 UI 文本、引导流程、空状态、文档、营销文案或其他品牌内容。
- 你需要关于何时使用 Plain Speech 与 Sentry Voice 的指导。
语调选择
根据上下文选择合适的语调：
| 使用 Plain Speech | 使用 Sentry Voice | |------------------|------------------| | 产品 UI（按钮、标签、表单） | 404 页面 | | 文档 | 空状态 | | 错误消息 | 引导流程 | | 设置页面 | 加载状态 | | 事务性邮件 | "新功能"公告 | | 帮助文本 | 营销文案 |
默认使用 Plain Speech，除非上下文明确需要个性化表达。
Plain Speech（默认）
Plain Speech 清晰、直接、功能性强。用于大多数 UI 元素。
规则
- 简洁 - 用最少的词表达
- 直接 - 告诉用户该做什么，而不是他们能做什么
- 使用主动语态 - "保存你的更改"而不是"你的更改将被保存"
- 避免术语 - 使用用户能理解的简单词汇
- 具体 - "发现 3 个错误"而不是"发现了一些错误"
示例
| 避免 | 应写为 | |------------|-------| | "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 在适当的时刻增添个性。它富有同理心、自我意识，偶尔带点讽刺。
原则
- 有同理心的讽刺 - 将不满指向情况本身，而非用户
- 自我意识 - 承认软件的荒谬之处
- 有趣但实用 - 个性应增强而非模糊含义
- 恰当的时机 - 仅在用户有时间欣赏时使用
示例
404 页面：
"这个页面不存在。也许它从未存在过。也许它只是一场梦。无论如何，让我们帮你回到正轨。"
空状态：
"还没有错误。趁现在享受这片刻的宁静吧。"
引导流程：
"让我们来捕获你的第一个错误。别担心，没有听起来那么可怕。"
加载状态：
"正在处理数据..." "正在获取你的数据..."
不应使用 Sentry Voice 的场景
- 错误消息（用户正感到沮丧）
- 设置页面（用户正在专注）
- 文档（用户需要信息）
- 账单/支付流程（用户需要信任感）
通用规则
拼写和语法
- 使用美式英语拼写（color，而非 colour）
- 标题和页面标题使用首字母大写
- 正文、按钮和标签使用句首大写
标点符号
- UI 文本中不使用感叹号（例外：庆祝时刻）
- 短 UI 标签或按钮文本中不使用句号
- 完整句子和帮助文本中使用句号
- 不使用全大写，缩写除外（API、SDK、URL）
用词选择
| 避免 | 推荐 | |-------|--------| | Please | （省略） | | Sorry | （具体说明问题） | | Error occurred | Something went wrong | | Invalid | （解释哪里出了问题） | | Success! | （描述发生了什么） | | Oops | （具体说明） |
破折号使用
| 类型 | 用途 | 示例 | |------|-----|---------| | 连字符 (-) | 复合词、范围 | "real-time"、"1-10" | | 短破折号 (--) | 范围、关系 | "2023--2024"、"parent--child" | | 长破折号 (---) | 中断、强调 | "Errors---even small ones---matter" |
在大多数 UI 场景中使用连字符。短破折号用于日期范围，长破折号用于较长的散文。
UI 元素指南
按钮
- 使用动作动词："Save"、"Delete"、"Create"
- 要具体："Create Project"而不仅仅是"Create"
- 尽可能保持 2-3 个词
- 不使用句号或感叹号
错误消息
- 说明发生了什么
- 说明原因（如果有帮助）
- 说明下一步该做什么
好的： "Could not save changes. Check your connection and try again." 差的： "Error: Save failed."
空状态
- 解释这里通常会显示什么
- 提供明确的操作来填充状态
- 此处适合使用 Sentry Voice
好的： "No projects yet. Create your first project to start tracking errors."
确认对话框
- 在标题中明确操作
- 如果是破坏性操作，解释后果
- 使用具体的按钮标签（"Delete Project"，而非"OK"）
工具提示和帮助文本
- 保持在 2 句以内
- 解释"为什么"，而不仅仅是"是什么"
- 复杂主题链接到文档
反模式
避免以下常见错误：
- 机器人式表达：