brand-guidelines

品牌指南

按照 Sentry 的品牌指南撰写面向用户的文案。

语气选择

根据上下文选择合适的语气：

使用平实表达	使用 Sentry 风格
产品 UI（按钮、标签、表单）	404 页面
文档	空状态
错误消息	引导流程
设置页面	加载状态
事务性邮件	“新功能”公告
帮助文本	营销文案

默认使用平实表达，除非上下文明确需要个性化表达。

平实表达（默认）

平实表达清晰、直接且实用。大多数 UI 元素都应使用这种表达方式。

规则

1. 简洁 - 用尽可能少的字表达清楚
2. 直接 - 告诉用户该做什么，而不是他们可以做什么
3. 使用主动语态 - 写“保存更改”，而不是“更改将被保存”
4. 避免术语 - 使用用户能理解的简单词语
5. 具体明确 - 写“发现 3 个错误”，而不是“发现一些错误”

示例

不要这样写	应这样写
“点击此处保存更改”	“保存”
“你可以按日期筛选结果”	“按日期筛选”
“发生了错误”	“出了点问题”
“请输入有效的电子邮件地址”	“输入有效的电子邮件地址”
“确定要删除吗？”	“删除此项？”

Sentry 风格

Sentry 风格会在适当的时候增添个性。它富有同理心、自省，偶尔还会带点调侃。

原则

1. 有同理心的调侃 - 针对当前情况直接表达挫败感，绝不针对用户
2. 自省 - 承认软件有时荒谬可笑
3. 有趣但实用 - 个性化表达应增强含义，而不是模糊含义
4. 把握时机 - 只在用户有时间体会时使用

示例

404 页面：

“此页面不存在。也许它从未存在过。也许这只是一场梦。无论如何，我们带你回到正轨。”

空状态：

“暂时还没有错误。趁这份平静还在，好好享受吧。”

引导流程：

“来看看你的第一个错误吧。别担心，听起来没那么吓人。”

加载状态：

“正在计算数据……” “正在获取你的数据……”

不要使用 Sentry 风格的场景

• 错误消息（用户正感到沮丧）
• 设置页面（用户正专注于操作）
• 文档（用户需要信息）
• 账单／付款流程（用户需要信任感）

通用规则

拼写和语法

• 使用美式英语拼写（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 元素指南

按钮

• 使用动作动词：“保存”、“删除”、“创建”
• 具体明确：“创建项目”，而不只是“创建”
• 尽可能控制在 2-3 个词以内
• 不加句号或感叹号

错误消息

1. 说明发生了什么
2. 说明原因（如有帮助）
3. 说明接下来该做什么

推荐：“无法保存更改。请检查连接并重试。” 不推荐：“错误：保存失败。”

空状态

1. 说明这里通常会显示什么
2. 提供明确的操作以填充此状态
3. 此处适合使用 Sentry Voice

示例：“还没有项目。创建你的第一个项目，开始跟踪错误。”

确认对话框

• 在标题中明确说明操作
• 如果操作具有破坏性，说明其后果
• 使用具体的按钮标签（“删除项目”，而不是“确定”）

工具提示和帮助文本

• 不超过 2 句话
• 解释“为什么”，而不只是“是什么”
• 对于复杂主题，链接到文档

反模式

避免以下常见错误：

• 机器人腔：“项目已成功删除” -> “已删除”
• 被动语态：“更改已被保存” -> “更改已保存”
• 多余用词：“为了” -> “为”
• 模棱两可：“这可能会导致……” -> “这会导致……”
• 双重否定：“并非不像……” -> “类似于……”
• UI 中的营销腔：“全面提升你的工作流” -> “加快你的工作流”

参考资料

• Sentry Voice 指南
• Sentry 前端手册