mcpField
S
stop-describing-ui

stop-describing-ui

github.com/artouc设计与 UI87790 次安装2 周前更新
代码仓库

关于 stop-describing-ui

stop-describing-ui 是用于编写和审核界面文案的技能。它倡导使用具体的操作标签和简洁、有用的提示，并删去仅解释页面或后端行为的文字。

主要功能

  1. 01用具体操作替换笼统动词
  2. 02只保留关键后果
  3. 03删去重复的功能说明
  4. 04通过修改前后对照审核文案
  5. 05采用简短的图标引导行

适用场景

  1. 01编辑产品界面的标签和辅助文本
  2. 02检查界面文案中的多余说明
  3. 03精简警告并保留破坏性操作后果

安装

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

$npx skills add https://github.com/artouc/stop-describing-ui --skill stop-describing-ui

安装后在 Claude Code 中输入/stop-describing-ui确认已加载。

详细介绍

停止描述 UI

界面会展示用户可以执行的操作，但不会自我解释。用户每读一句话，就得多花一步才能采取行动；因此，只有当用户不看这句话就会犯实际错误时，才保留这句话。

编写 UI 时，请遵循以下规则。审核 UI 时，请逐条检查所有文案，应用每条规则，并以修改前和修改后的形式展示结果。

规则

1. 不要描述功能

直接命名操作。标题、控件及其标签已经说明了页面的用途。

修改前

# Projects
## No projects yet.
### Choose a GitHub repository and we'll deploy on every push.
+ New

修改后

# Projects
+ Connect repository
2. 使用具体动词

选择能准确描述实际操作的动词，并说明操作对象。如果有更精确的动词，就避免使用「新建」「创建」「管理」「设置」「配置」「前往」或「确定」等泛泛的动词。在上面的示例中，「新建」会改成「连接代码库」。

3. 只保留最关键的后果

一个操作有多种影响时，只说明最重要的一项，省略其余影响。由此带来的影响不言自明。例如，在通过 AI 自动回复接受预订的预订服务中，关闭自动回复显然也会停止接受预订。

修改前

Turning this off stops AI auto-replies and web reservations. Customer messages are saved only to the conversation log. You can turn it back on anytime from "Replies off" in the header.

修改后

Temporarily turns off AI auto-replies.

不可逆或具有破坏性的影响，例如删除数据、扣款或通知客户，就是关键后果，必须始终保留。

4. 不要描述后端行为

数据存储在哪里、记录了什么、同步了什么，以及后台运行了什么，都与用户无关。在上面的示例中，「客户消息仅保存到对话日志中」应删除。

5. 同一个控件可以撤销操作时，不要说明如何撤销

关闭某个选项的开关也可以重新打开该选项。只有在撤销操作需要使用不同的控件或前往不同的位置时，才说明如何撤销。

6. 不要解释页面已经说明的内容

页面标题、导航和版块结构都承载着含义。在「选项」页面上，用户已经知道自己正在查看选项。

修改前

# Other options
### Options that become available with a contract. They cannot be toggled on or off.

修改后

# Other
7. 不要说明不存在的内容

如果界面已经展示了情况，就不要说明当前没有任何项目、某项内容无法切换，或某项功能不可用。空列表配上明确的操作，就已经说明「这里还没有内容」。没有开关的行，就已经说明「无法切换」。

例外情况是用户可能会尝试但最终失败的限制，例如因角色权限不足而无法执行的操作。按照规则 9，用一行简短文字和一个图标保留这类说明。

8. 展示如何启用，不要写出来

如果订阅、升级、连接或开启某个设置后才能使用某项功能，就在界面上放置相应的按钮或开关。不要写一句话告诉用户该去哪里或该做什么。

修改前

Sign up for the Pro plan to use this option.

修改后

[Upgrade to Pro]
9. 不要只依赖文字

将文字拆分成短行，并在每行开头加上图标。使用间距和分组来构建结构。

绝不要将 ->、>、|、✔️、!、→ 或 : 用作分隔符、箭头、项目符号或强调标记。请改用图标或间距。

修改前

Searches across all stores and shows the results. Stores you don't belong to are shown as Operator, and every action records who did what in which store. You can't change applications, payment methods, or plans, or send messages to customers (replies, approving or declining tentative reservations).

修改后

(icon) Every action is recorded
(icon) You can't change applications, payment methods, or plans, or send messages to customers

按照规则 1，「搜索所有商店并显示结果」应删除；按照规则 6，「显示为 Operator」应删除，因为 UI 已经标注了这些内容；按照规则 4，详细的记录格式也应删除。

检查清单

依次检查每条文案。

  1. 它是否解释了该功能是什么？删除它，或改成具体的操作标签。
  2. 动词是否泛泛而谈？换成能说明实际操作及对象的动词。
  3. 它是否列出了多个结果？只保留最重要的一项。
  4. 它是否提到存储、日志记录、同步或其他内部机制？删除它。
  5. 它是否说明如何通过同一控件撤销操作？删除它。
  6. 页面标题或导航中是否已经说明了？删除它。
  7. 它是否说某项功能缺失或不可用？删除它，除非用户否则会尝试后失败。
  8. 它是否告诉用户如何启用某项功能？替换为对应的按钮或开关。
  9. 它是否是一段文字，或使用符号作分隔？拆分成以图标开头的行，并添加间距。

如果检查后什么都不剩，就留空。留空辅助文本区域也好过填充无用文案。

评论

支持 Markdown