mcpField
C
content-style-guide

content-style-guide

github.com/bitwarden设计与 UI16244 次安装今天更新
代码仓库

关于 content-style-guide

面向 Bitwarden 用户界面文案审查的 Skill,提供语气指导、评审步骤,并指向详细的语法与无障碍规则。

主要功能

  1. 01产品语气与风格指导
  2. 02按内容类型划分语气
  3. 03结构化文案评审格式
  4. 04语法与无障碍参考
  5. 05Figma 文案验证指导

适用场景

  1. 01审查错误消息和对话框
  2. 02检查引导与空状态文案
  3. 03验证 Figma 设计中的字符串

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/bitwarden/ai-plugins --skill content-style-guide

安装后在 Claude Code 中输入/content-style-guide确认已加载。

附带文件references/accessibility-rules.mdreferences/grammar-mechanics.md

详细介绍

产品内容风格指南

此技能以 Bitwarden 的产品内容风格指南为依据,指导 GUI 文案决策。仅适用于面向最终用户的字符串,例如按钮标签、错误消息、提示气泡、模态框、引导流程、空状态、表单标签、辅助文本、链接文本等。不要将其用于设计令牌、代码注释、面向内部或开发者的字符串,或营销文案。

如果不确定某个具体情况,请先询问,再修改文案。

语气与风格

品牌声音保持一致,语气随上下文变化。

产品声音应当亲切、鼓励且坦诚,并在各个平台保持一致。

语气传达情绪,取决于你在与谁交流,以及当时发生了什么。安全是严肃的事。用户并不想要幽默或空话——他们想知道自己的信息是否安全。因此,Bitwarden 产品的语气几乎始终严肃而尊重。

语气维度:

  • 随意 ↔ 正式
  • 热情 ↔ 客观

常见内容类型在语气图中的位置(坐标轴:随意 ↔ 正式 × 客观 ↔ 热情):

内容类型随意 / 正式客观 / 热情
成功消息随意热情
引导文案随意热情
对话框随意客观
空状态随意客观(略微)
标签中性客观
社区正式热情
确认信息正式客观
帮助文章正式(略微)中性
警告正式客观
错误状态正式客观
示例

错误消息——正式、客观:

  • 好:发生错误。请重试。
  • 避免:哎呀!我们搞砸了。刷新一下吧!

引导消息——随意、热情:

  • 好:你好!👋 欢迎使用 Bitwarden。我们来带你熟悉一下!
  • 避免:这是你的保险库。立即开始使用。

应用此技能

在明确要求评审文案时(“评审一下这段文案”“这条错误消息可以吗”):

  1. 确定内容类型(错误、引导、按钮等),并根据上面的语气图判断预期语气。
  2. 检查品牌声音是否一致(亲切、鼓励、坦诚)。
  3. 检查与该片段相关的语法和行文规则——参见 references/grammar-mechanics.md。
  4. 检查与该片段相关的无障碍规则——参见 references/accessibility-rules.md。
  5. 提供具体、可执行的改写,而不只是说“这不对”。

在 figma-to-angular 运行期间(clients 仓库中的外部技能,此处未打包):

如果 Figma 设计包含文案字符串,请在将其写入 Angular 模板之前,根据本指南进行检查。如果某个字符串明显违反规则(例如,按钮使用标题式大小写、使用 & 符号、链接写着“点击这里”),请指出问题并提出符合规范的替代方案——不要悄悄改写。询问用户要采用哪种方案。

在设计评审意见中:

如果处于 60% 或 90% 阶段,请在视觉反馈之外补充内容方面的观察(90% 阶段适合进行“细致的语法检查并敲定文案”)。在 30% 阶段跳过内容方面的细枝末节——文案之后还会修改。内容反馈应与视觉反馈采用相同的方式表达:着眼于用户和产品目标,而非个人喜好。

文案批评的输出格式

  1. 内容类型和预期语气 — 说明这段文案是什么,以及应处于语气光谱的哪个位置。
  2. 值得保留之处 — 指出哪些内容值得保留。
  3. 问题 — 每个问题都要对应本指南中的具体规则(如果规则位于参考文件中,请注明文件名和章节名)。
  4. 建议改写 — 提供具体的替代文案,供用户选择。

批评应具体明确。“按钮使用了标题式大小写;应遵循 references/grammar-mechanics.md(Capitalization)中的句式大小写规则”比“大小写不对”更好。

其他资源

详细规则位于两个参考文件中。只有在批评需要时才查阅这些文件——大多数文案问题只涉及一两条规则。

  • references/grammar-mechanics.md — 首字母缩写、& 符号、大小写(句式大小写、产品名称、功能名称、小写对象)、日期和月份、星期、e.g. / i.e.、省略号、文件大小和格式、金额、数字、牛津逗号、时间和时区、versus。
  • references/accessibility-rules.md — 阅读难度和直接表达、便于快速浏览的布局、非英语和英语学习者相关注意事项、拼写首字母缩写、避免使用“容易”和“简单”的表述、文本样式、空间方位用语、替代文本、有意义的链接文本、性别中立代词。

评论

支持 Markdown