# Brand Guidelines

> 按照 Sentry 品牌规范撰写文案。涵盖 UI 文本、错误消息、空状态、引导流程、404 页面、文档、营销文案及所有面向用户的内容。包含 Plain Speech（默认）和 Sentry Voice 两种语调。当用户要求'写品牌文案'、'Sentry 语气'、'UI 文案'、'品牌规范'、'品牌指南'、'Sentry Voice'、'Plain Speech'时使用。

- Skill: `kscz0000/brand-guidelines` (Agent Skill)
- Install (CLI): `npx skillmds@latest add kscz0000/brand-guidelines`
- Raw SKILL.md: https://api.skillmd.com/api/skills/kscz0000/brand-guidelines/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: kscz0000 (https://skillmd.com/u/kscz0000)
- Updated: 2026-09-21
- Page: https://skillmd.com/skills/kscz0000/brand-guidelines

---


# 品牌规范

按照 Sentry 品牌规范撰写面向用户的文案。

## 适用场景
- 需要用 Sentry 的语气撰写或改写面向用户的文案。
- 任务涉及 UI 文本、引导流程、空状态、文档、营销文案或其他品牌内容。
- 需要判断何时使用 Plain Speech、何时使用 Sentry Voice。

## 语调选择

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

| 使用 Plain Speech | 使用 Sentry Voice |
|------------------|------------------|
| 产品 UI（按钮、标签、表单） | 404 页面 |
| 文档 | 空状态 |
| 错误消息 | 引导流程 |
| 设置页面 | 加载状态 |
| 事务性邮件 | "新功能"公告 |
| 帮助文本 | 营销文案 |

**默认使用 Plain Speech**，除非上下文明确需要个性化语气。

## Plain Speech（默认）

Plain Speech 清晰、直接、功能导向。适用于大多数 UI 元素。

### 规则

1. **简洁** - 用最少的字表达
2. **直接** - 告诉用户该做什么，而不是能做什么
3. **主动语态** - "保存更改"而非"更改将被保存"
4. **避免术语** - 使用用户能理解的简单词汇
5. **具体** - "发现 3 个错误"而非"发现了一些错误"

### 示例

| 不要写 | 应该写 |
|------------|-------|
| "点击此处保存您的更改" | "保存" |
| "您可以按日期筛选结果" | "按日期筛选" |
| "发生了一个错误" | "出了点问题" |
| "请输入有效的电子邮件地址" | "输入有效的邮箱" |
| "您确定要删除吗？" | "删除此项？" |

## Sentry Voice

Sentry Voice 在合适的时机增添个性。它有同理心、有自知之明，偶尔带点俏皮。

### 原则

1. **有同理心的俏皮** - 指向情境的挫败感，绝不指向用户
2. **自知** - 承认软件本身的荒诞
3. **有趣但有用** - 个性应增强表达，而非掩盖含义
4. **恰当时机** - 只在用户有余暇欣赏时使用

### 示例

**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 元素指南

### 按钮

- 使用动作动词："保存"、"删除"、"创建"
- 要具体："创建项目"而非仅"创建"
- 尽量不超过 2-3 个词
- 不加句号或感叹号

### 错误消息

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

**好：** "无法保存更改。请检查网络连接后重试。"
**差：** "错误：保存失败。"

### 空状态

1. 解释这里通常会有什么
2. 提供明确的操作来填充内容
3. 此处适合使用 Sentry Voice

**好：** "还没有项目。创建你的第一个项目，开始追踪错误。"

### 确认对话框

- 在标题中明确操作
- 如为破坏性操作，说明后果
- 使用具体的按钮标签（"删除项目"，而非"确定"）

### 工具提示和帮助文本

- 不超过 2 句话
- 解释"为什么"，而非仅解释"是什么"
- 复杂主题链接到文档

## 反模式

避免以下常见错误：

- **机器腔：** "项目已成功删除" -> "已删除"
- **被动语态：** "更改已保存" -> "更改已保存"（中文语境下主动被动差异较小，英文原文："Changes were saved" -> "Changes saved"）
- **多余用词：** "为了" -> "来"
- **含糊其辞：** "这可能会导致..." -> "这会导致..."
- **双重否定：** "并非不像..." -> "类似于..."
- **UI 中的营销腔：** "超级赋能你的工作流" -> "加速你的工作流"

## 参考资料

- [Sentry Voice 规范](https://develop.sentry.dev/frontend/sentry-voice/)
- [Sentry 前端手册](https://develop.sentry.dev/frontend/)

## 局限性
- 仅在任务明确符合上述范围时使用本技能。
- 输出不能替代针对具体环境的验证、测试或专家评审。
- 若缺少必要的输入、权限、安全边界或成功标准，请停下来请求澄清。