name: 品牌指南 description: 根据Sentry品牌指南编写文案。适用于编写UI文本、错误消息、空状态、引导流程、404页面、文档、营销文案或任何用户-facing内容。涵盖Plain Speech(默认)和Sentry Voice两种语气。
品牌指南
遵循Sentry的品牌指南编写用户-facing文案。
语气选择
根据上下文选择适当的语气:
| 使用Plain Speech | 使用Sentry Voice |
|---|---|
| 产品UI(按钮、标签、表单) | 404页面 |
| 文档 | 空状态 |
| 错误消息 | 引导流程 |
| 设置页面 | 加载状态 |
| 事务性电子邮件 | “新增功能”公告 |
| 帮助文本 | 营销文案 |
默认使用Plain Speech,除非上下文需要个性。
Plain Speech(默认)
Plain Speech清晰、直接、功能性。适用于大多数UI元素。
规则
- 简洁 - 使用最少所需的词语
- 直接 - 告诉用户做什么,而不是他们可以做什么
- 使用主动语态 - “保存更改”而非“您的更改将被保存” | 避免 | 偏好 | |-------|--------| | 请 | (省略) | | 抱歉 | (具体说明问题) | | 发生错误 | 出现问题 | | 无效 | (解释错误) | | 成功! | (描述发生了什么) | | 哎呀 | (具体说明) |
破折号使用
| 类型 | 用途 | 示例 |
|---|---|---|
| 连字符 (-) | 复合词、范围 | “实时”、“1-10” |
| 短破折号 (–) | 范围、关系 | “2023–2024”、“父–子” |
| 长破折号 (—) | 中断、强调 | “错误—即使是小错误—也很重要” |
在大多数UI上下文中,使用连字符。短破折号保留用于日期范围,长破折号用于较长散文。
UI元素指南
按钮
- 使用动作动词:“保存”、“删除”、“创建”
- 具体:“创建项目”而非只是“创建”
- 尽可能2-3个词
- 无句号或感叹号
错误消息
- 说明发生了什么
- 说明原因(如有帮助)
- 说明下一步操作
好: “无法保存更改。检查连接后重试。” 不好: “错误:保存失败。”
空状态
- 解释通常这里应有什么
- 提供明确操作来填充状态
- Sentry Voice适合此处
好: “尚无项目。创建第一个项目以开始跟踪错误。”
确认对话框
- 在标题中明确动作
- 如有破坏性操作,说明后果
- 使用具体按钮标签(“删除项目”,而非“确定”)
工具提示和帮助文本
- 保持不超过2句话
- 解释“为什么”,而不仅仅是“是什么”
- 对于复杂主题,链接到文档
反模式
避免这些常见错误:
- 机器人语言: “项目已成功删除” -> “已删除”
- 被动语态: “更改已保存” -> “保存更改”
- 不必要的词语: “为了” -> “以”
- 犹豫: “这可能引起…” -> “这将引起…”
- 双重否定: “并非不像…” -> “类似于…”
- UI中的营销语言: “超级增强您的工作流程” -> “加速您的工作流程”