跳转到使用指南
ux-writing作者 content-designer

UX Writing Skill.

Claude Code 和 Codex 的 UX 研究 skill:以用户为中心的无障碍微文案:按钮、标签、错误提示、表单、引导流程。

  • UX & Research
content-designer/ux-writing-skill · SKILL.mdSKILL.md
--- name: ux-writing description: Create user-centered, accessible interface copy (microcopy) for digital products including buttons, labels, error messages, notifications, forms, onboarding, empty states, success messages, and help text. Use when writing or editing any text that appears in apps, websites, or software interfaces, designing conversational flows, establishing voice and tone guidelines, auditing product content for consistency and … --- ## When to Use This Skill ## Core UX Writing Principles ## UX Text Patterns ## Voice and Tone ## Editing Process ## Workflow
从上游文件读取的 front matter 和章节标题,日期 2026-09-14 · 完整内容 15,313 字符

01 功能说明

ux-writing Skill 在 Claude Code 和 Codex 中的作用

摘要、工作流与产物,均读自该 skill 的 SKILL.md。

来自 SKILL.md读取于 2026-09-14 · 非实际运行记录

以 skill 自身的术语

一份用于编写和编辑数字产品微文案的实操指南:按钮、标签、标题、错误消息、通知、表单、引导流程、空状态、成功消息和帮助文本。每条文案都会依据四项质量标准来评判——目的明确、简洁、口语化和清晰——并且每种元素类型都有对应的模式,例如按钮使用 [Verb] [object],错误消息使用 [What failed]。

错误消息使用 [Why/context]. [What to do]. 的模式。语气(Voice)被视为固定的品牌个性,而语调(tone)则会随用户处于沮丧、困惑、自信、谨慎或成功状态而变化。该 skill 还加入了无障碍规则、基于研究的句子和字符长度基准、一个四阶段编辑流程,以及涵盖语气图、内容可用性和 Figma MCP 的参考文件。

它产出什么

  • 界面文案本身,涵盖按钮、标签、错误消息、通知、表单及相关元素。
  • 基于 references/voice-chart-template.md 构建的产品语气图,将品牌概念映射到语气特征,并给出正确/错误示例。
  • 根据 templates/error-message-template.md(一个可填写的有效错误消息模板)撰写的错误消息。
  • 根据 templates/onboarding-flow-template.md 设计的引导流程,这是构建清晰引导体验的框架。
查看示例提示词 ↗

工作方式

  1. 01
    从上下文开始

    第一步是在动笔之前理解用户目标、业务目标、技术限制以及用户的情绪状态。

  2. 02
    以口语化表达起草

    从你会脱口而出的话开始,应用该元素的模式,权衡语音与语调,然后把重要信息放在前面。

  3. 03
    分四个有序阶段进行编辑

    该文件规定了四个阶段,按顺序执行:目的明确、简洁、口语化、清晰,每个阶段都有自己的检查问题。

  4. 04
    让语调匹配当下情境

    语调会根据用户的情绪状态——沮丧、困惑、自信、谨慎、成功——进行调整,而语音保持不变。

  5. 05
    测试与衡量

    先与团队一起复审,条件允许时再与用户测试,然后衡量任务完成度与理解度,而不是凭主观意见判断。

02 找到适合场景

何时使用 ux-writing Skill

当工作是此类 UX 研究时,在 Claude Code 或 Codex 中使用 ux-writing skill。以下适用范围和限制来自该 skill 自己的文件。

适合场景

  • 为界面元素撰写全新文案:按钮、标签、标题、消息和表单。
  • 编辑已经上线但读起来不佳的现有 UX 文案。
  • 审查产品内容在各屏幕之间的一致性与可用性。
  • 撰写能解释问题并帮助恢复的错误、通知和成功消息。
  • 确立产品的语音与语调,或设计引导流程与对话式流程。

了解边界

  • 无法在 ChatGPT 中使用——该文件说明它运行于 Codex CLI/IDE,且 ChatGPT 无法安装或使用 skill。
  • 诸如“出了点问题”这类含糊的失败说明被列为应避免的做法。
  • 在严肃场合中,过度卖弄的幽默是不合适的。

需要提供的信息

  • 用户的情绪状态与利害关系语调的选择取决于用户当下的感受以及风险高低——低风险的主题切换与删除账户所呈现的语调应有所不同。
  • 无障碍限制视觉上下文对某个元素是否已经足够,或者是否需要为辅助技术提供明确的标签与 ARIA 标签。

03 Skill 内部

ux-writing skill 赋予 Claude Code 与 Codex 的规则

SKILL.md 为 Agent 设定的 8 条具体指令、默认值与限制——文件中真正改变结果的部分。

  1. 每行 40-60 个字符

    界面文本每行应保持在 40-60 个字符,这是该文件设定的最大可读范围。

  2. 按钮:2-4 个字

    按钮与 CTA 文案应为 2-4 个字,最多不超过 6 个字。

  3. 按受众划分的通俗语言

    面向大众受众的文案应达到 7 年级阅读水平,面向专业场景应达到 10 年级水平。

  4. 85% 的时间使用主动语态

    文案中大约 85% 应使用主动语态。

  5. 错误文案遵循固定顺序

    错误文案先说明失败了什么,再说明原因或上下文,最后说明该怎么做——按此顺序排列。

  6. 绝不归咎于用户

    错误文案应承认问题的存在,但不将责任归咎于阅读它的人。

  7. 绝不单靠颜色传达含义

    含义永远不应仅由颜色单独传达;视觉标识须与文字配合使用。

  8. 错误信息:12-18 个字

    一条错误信息(包括解决方案)的长度应控制在 12 到 18 个字之间。

04 投入使用

在 Claude Code 或 Codex 中安装 ux-writing

一条 npx skills add 命令,然后在你的 Agent 中执行第一个任务和对结果的清单检查。

将 ux-writing 添加到 Claude Code、Codex 或你的 Agent

在你的项目中运行;安装程序会询问要把它添加到哪个 Agent。

Terminal
npx skills add https://github.com/content-designer/ux-writing-skill --skill ux-writing

用于 SKILL.md 的通用 skills CLI 形式;仓库可能会记录自己的路径。

给 Skill 第一个 UX 研究任务

按 skill 自身的术语撰写;把括号中的部分换成你的内容。

Starter prompt
Write the microcopy for our [checkout] flow: the payment button label, the field labels, and the message a user sees when their card is declined. The user will be frustrated, so keep the tone empathetic and give a clear next step. Then run the four-phase edit and flag any line over 60 characters.

来源:依据 SKILL.md,按 skill 自身的术语撰写。

检查首次结果

SKILL.md 本身如何描述正确的结果:

  • 朗读文案,判断你是否真的会这样说话。
  • 用可读性工具检测文案;文件名为 Hemingway Editor 与 Flesch-Kincaid 评分。
  • 核对理解度基准:8 个词以内可达到 100% 理解度,14 个词以内可达到 90%。
  • 参照 references/content-usability-checklist.md 逐项检查,这是随附的用于评估 UX 文案质量的清单。
  • 让团队进行评审并与用户一起测试,衡量任务完成度和理解度,而非凭个人喜好判断。
  • 出于无障碍考虑,确认错误结构合理,使屏幕阅读器能将错误信息与字段标签一并读出。

在 OpenDesign 中,通过 SKILL.md 链接导入 ux-writing:Plugins → Add → Skill → Import from link,然后在顶部栏中选择它。

05 开源、可追溯

来源、许可与验证

本页面事实的来源,以及最后检查时间。

Skill 文件
SKILL.md 验证时记录的内容校验和;提交 98cacde
License
MIT 来自 LICENSE。
仓库星标数
168 GitHub 快照摄于 2026-09-14,对应整个 content-designer/ux-writing-skill 仓库。不是 ux-writing 的评分或使用量。
已由 OpenDesign 验证
2026-09-14 已检查源文件、路径、许可文本和 star 数量。未内置在 OpenDesign 主程序(检查日期 2026-08-28);本页面未记录实际运行。

SKILL.md 内部

  1. 何时使用此 Skill六种触发场景:编写或编辑界面文案、消息、对话流程、语气,以及内容审核。
  2. UX 写作核心原则四项质量标准,加上简洁性、清晰度、对话式语气与以用户为中心的实践。
  3. UX 文本模式标题、按钮、四种错误类型、成功提示、空状态、表单与通知的格式与示例。
  4. 语气与风格建立稳定的语气;根据用户情绪状态和内容类型调整风格。
  5. 编辑流程四个有序阶段——目的明确、简洁、口语化、清晰——每一阶段都有对应的检查问题。
  6. 工作流理解上下文,起草,通过四个阶段反复编辑,然后测试与衡量效果。
  7. UX 文案中的无障碍性屏幕阅读器、认知、多模态与简明语言方面的要求,附带不佳与良好范例。
  8. UX 文案基准按元素划分的句子与字符目标、理解率、阅读难度水平及测试工具。
  9. 常见错误提醒十一种反模式,从被动语态、泛化标签到不可访问的链接文本。
  10. 快速参考关于句首大写、按钮祈使句、以用户为中心、动词具体化和信息前置的一句话提醒。
  11. 资源九个随附文件:无障碍指南、语气图表、可用性检查清单、范例、模板及 Figma 集成。
Skill 自身的描述
"为数字产品创建以用户为中心、具有无障碍性的界面文案(微文案),包括按钮、标签、错误消息、通知、表单、引导流程、空状态、成功消息和帮助文本。用于编写或编辑应用、网站或软件界面中出现的任何文本、设计对话流程、建立语音和语调指南、审查产品内容的一致性和可用性、审查 UI 字符串或改进现有界面文案时使用。应用基于四个质量标准的 UX writing 最佳实践——有目的、简洁、对话化和清晰。包括无障碍指南、基于研究的基准(句子长度、理解率、阅读水平)、扩展的错误模式、语调适应框架和全面的参考资料。"

来自 SKILL.md 的前言描述。完整文件约 15,313 字符。在 GitHub 上阅读完整文件。

06 安装之前

关于 ux-writing skill 的常见问题

以下回答来自 2026-09-14 读取到的 SKILL.md,而非某次实际运行的记录。

哪些 Agent 可以运行这个 skill?

它面向 Claude、Codex、Cursor 以及其他任何支持 agent skills 规范的 Agent 编写。ChatGPT 被明确排除在外——它无法安装或使用 skill。

我可以用它处理已有的文案吗?

可以。这个 skill 涵盖编辑已有的 UX 文本、审查 UI 字符串以及审核产品内容的一致性与可用性,而不仅是从零开始撰写。

它涉及无障碍性吗?

是的。无障碍写作是独立的一个部分,涵盖屏幕阅读器优化、认知无障碍、多模态沟通和简明语言,并要求达到 WCAG AA 的最低色彩对比度 4.5:1。

UX Writing

在真实的 UX 研究任务中运行 ux-writing。

下载 OpenDesign,从其 SKILL.md 链接导入 ux-writing,粘贴上述提示,并在得到结果前阅读计划。

终端
npx skills add https://github.com/content-designer/ux-writing-skill --skill ux-writing

OpenDesign 桌面客户端

一套设计系统,让每一次创作都保持品牌一致

在完整的 Vibe Design Workspace 中,用同一套品牌规则生成网页、PPT、可交互原型、数据看板、图像与 HTML 视频。连接本地 Codex、Claude Code、Cursor 等编程助手,即可免费创作。

  • 覆盖网页、PPT、原型、数据看板、图像与视频
  • 140+ 设计系统,以及完整模板与技能库
  • 连接本地 Codex 与 21+ 款编程助手 · 免费使用
免费下载

支持 macOS 与 Windows