关于 brand-guidelines
用于按照 Sentry 品牌语调撰写面向用户文案的技能,帮助根据场景选择直白表达或更具个性的语气,并提供界面、文档等内容的写作指南。
主要功能
- 01Plain Speech 与 Sentry Voice 指南
- 02按内容类型选择语气
- 03界面文本与错误消息规则
- 04拼写和标点规范
- 05文案模式示例
适用场景
- 01改写产品界面标签
- 02撰写引导流程和空状态
- 03编辑文档与帮助文本
- 04编写品牌公告
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ sickn33/ agentic-awesome-skills --skill brand-guidelines安装后在 Claude Code 中输入/brand-guidelines确认已加载。
详细介绍
品牌指南
按照 Sentry 的品牌指南撰写面向用户的文案。
适用场景
- 需要用 Sentry 的口吻撰写或改写面向用户的文案。
- 任务涉及 UI 文本、新手引导、空状态、文档、营销文案或其他品牌内容。
- 需要了解何时使用 Plain Speech,何时使用 Sentry Voice。
选择语气
根据上下文选择合适的语气:
| 使用 Plain Speech | 使用 Sentry Voice |
|---|---|
| 产品 UI(按钮、标签、表单) | 404 页面 |
| 文档 | 空状态 |
| 错误消息 | 新手引导流程 |
| 设置页面 | 加载状态 |
| 事务性邮件 | “What's New” 公告 |
| 帮助文本 | 营销文案 |
默认使用 Plain Speech,除非上下文明确需要个性化表达。
Plain Speech(默认)
Plain Speech 清晰、直接、实用。适用于大多数 UI 元素。
规则
- 简洁——用尽可能少的词表达清楚
- 直接——告诉用户要做什么,而不是可以做什么
- 使用主动语态——说“保存更改”,不要说“更改将被保存”
- 避免术语——使用用户能理解的简单词语
- 具体明确——说“发现 3 个错误”,不要说“发现一些错误”
示例
| 不要写 | 应写 |
|---|---|
| “点击此处保存更改” | “保存” |
| “你可以按日期筛选结果” | “按日期筛选” |
| “发生了错误” | “出了点问题” |
| “请输入有效的电子邮件地址” | “输入有效的电子邮件地址” |
| “确定要删除吗?” | “删除此项?” |
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 元素指南
按钮
- 使用动作动词:“保存”、“删除”、“创建”
- 表述具体:“创建项目”,不要只写“创建”
- 尽可能控制在 2–3 个词以内
- 不加句号或感叹号
错误消息
- 说明发生了什么
- 说明原因(如有帮助)
- 说明接下来该怎么做
好:“无法保存更改。请检查网络连接后重试。” 不好:“错误:保存失败。”
空状态
- 说明这里通常会显示什么
- 提供明确的操作来填充此状态
- 适合使用 Sentry Voice
好:“还没有项目。创建第一个项目,开始跟踪错误。”
确认对话框
- 在标题中明确说明操作
- 如果操作具有破坏性,说明后果
- 使用明确的按钮标签(“删除项目”,而不是“确定”)
工具提示和帮助文本
- 控制在 2 句话以内
- 解释“为什么”,而不仅仅是“是什么”
- 对于复杂主题,链接到文档
反面模式
避免以下常见问题:
- 机器人式表达:“项目已成功删除” -> “已删除”
- 被动语态:“更改已被保存” -> “更改已保存”
- 不必要的词语:“为了……” -> “要……”
- **空洞的委婉表达:**只有在证据支持确定性时才删除填充语。后果不确定时保留“可能”;绝不要把可能性改成保证。
- 双重否定:“并非不像……” -> “类似于……”
- UI 中的营销话术:“为你的工作流注入超强动力” -> “加快你的工作流”
参考资料
限制
- 仅当任务明确符合上述范围时,才使用此技能。
- 不要将输出视为环境特定验证、测试或专家审核的替代品。
- 如果缺少必要的输入、权限、安全边界或成功标准,请暂停并要求澄清。
评论
支持 Markdown