Agent Skills › jakubkrehel/skills › better-writing

better-writing

GitHub

负责撰写和审查界面文案(如标签、错误提示),确保符合产品语调并指导用户操作。涵盖术语统一、语气调整及直接面向读者的写作规范,提升用户体验与一致性。

skills/better-writing/SKILL.md jakubkrehel/skills

Trigger Scenarios

需要生成或优化界面文案时 审查现有UI文本的清晰度与语调一致性时

Install

npx skills add jakubkrehel/skills --skill better-writing -g -y
More Options

Use without installing

npx skills use jakubkrehel/skills@better-writing

指定 Agent (Claude Code)

npx skills add jakubkrehel/skills --skill better-writing -a claude-code -g -y

安装 repo 全部 skill

npx skills add jakubkrehel/skills --all -g -y

预览 repo 内 skill

npx skills add jakubkrehel/skills --list

SKILL.md

Frontmatter
{
    "name": "better-writing",
    "description": "Writes and reviews your interface copy, from labels and errors to empty states and confirmations, so it matches your product's voice and tells people what to do next."
}

Writing

This skill writes and reviews interface copy such as labels, errors, empty states and confirmations, along with the terms that run through them. It matches the product's existing voice and flags copy that misleads people or leaves them without a way forward.

A deliberate brand voice is not a defect. Raise a departure from plain language only when it creates inconsistency, ambiguity, translation risk or a tone the stakes don't support. Rewording that merely suits your taste is not a finding.

How copy renders, including text-transform, truncation and smart punctuation, belongs to better-typography. Error markup, announcements and the attributes that carry accessible names belong to better-accessibility. Room for translated strings belongs to better-layout.

Inventory the existing strings first

Before writing or reviewing, find where the copy lives and read the copy around the change:

  1. Search for the translation call (t(, i18n., <FormattedMessage, $t() and the locale files it reads, such as locales/**/*.json, messages/*.json, *.po and *.strings. Copy may also come from a CMS or the API.
  2. List the noun used for each object and the verb used for each action, as in "project" or "workspace" and "Delete" or "Remove".
  3. Note the case used per element type and any voice or content style guide.

New copy uses the terms on that list. A synonym is a finding only where the same thing is named two ways.

One voice, one vocabulary

The product has one voice and its existing copy establishes it. A local edit does not get to invent a new one. If it's "Archive" in the menu, it isn't "Move to storage" in the toast.

A multi-step flow uses one vocabulary throughout: "Get started" to enter, either "Continue" or "Next" to advance, "Done" to finish. Tone flexes with the stakes:

Context Tone
Success, onboarding, empty states Warm, can be light
Routine actions, settings Neutral, minimal
Errors, destructive confirmations Calm, plain, zero playfulness
Data loss, security Serious, explicit

Address the reader directly

In instructional copy, write "you", not "the user". In errors, "we" reads as deflection, so prefer "Unable to load content. Check your connection and try again." An established first-person voice can stay in low-stakes copy where it still reads clearly.

Use possessives sparingly: "Favorites" beats "Your favorites". Never mix perspectives in one flow, such as "My account" beside "Your settings".

Plain words over clever ones

Choose words a tired reader gets on the first pass, and delete every word that does no work. No idioms, no colloquialisms and no humor that won't translate.

Skip unnecessary gender: "Subscribers can post recipes", not "each subscriber can post his or her recipes". Match the input device: "tap" on touch, "click" with a pointer, "select" when both are possible.

Build strings whole

Never assemble a sentence from fragments around a variable ("You have " + n + " new messages"), because word order changes per language. Write one message with placeholders, and use the locale's plural rules rather than n === 1 ? "" : "s". Many languages have more than two plural forms. Format numbers, dates and lists through Intl. Recipes are in patterns.md.

Verb-first buttons

A button label starts with a verb naming the action: "Send", "Save draft", "Delete project". Never "OK!" or "Let's go!".

An icon-only button's accessible name follows the same rule. It names the action, "Delete project", never the glyph, "Trash icon". The attribute that carries it is better-accessibility's.

Links describe their destination

Link text makes sense out of context, because screen-reader users navigate by a list of the page's links. Write "Read the billing docs", never "Click here".

A bare "Learn more" breaks down as soon as two appear on one page. Suffix each one: "Learn more about exports".

One capitalization policy

Pick title case or sentence case per element type, then apply it to every instance of that type. Sentence case is the default where the project has no policy. "Save Changes" beside "Discard changes" reads as sloppiness.

Settings describe the ON state

Label a toggle for what happens when it is on. "Send read receipts" lets users infer the off state; "Don't send read receipts" turns the toggle into a double negative.

Link straight to a referenced setting rather than describing the path to it: a "Notification settings" link, not "Go to Settings > Notifications > Email".

Errors say how to fix, next to where it broke

An error is an instruction, and it belongs beside the field that failed:

Bad Good
That password is too short Choose a password with at least 8 characters
Invalid date Enter a date as DD/MM/YYYY
Oops! Something went wrong. Unable to save. Check your connection and try again.

No blame, no "oops" and no exclamation marks. Phrase hints positively, as in "Use at least 8 characters" rather than "Don't use fewer than 8". Show a known requirement as helper text before input, not only in the error. When the same error keeps firing, redesign the interaction so it cannot happen.

Undo beats confirmation

Prefer undo when the action can be reversed and people perform it often, such as archiving, moving or deleting into a trash. Act at once and offer undo in the result: "Project archived. Undo".

Confirm before acting when the action cannot be reversed, affects other people or destroys many items at once. The confirmation repeats the consequence, so the dialog is answerable without reading the body:

  • The title names the action and the object, "Delete 'Q3 report'?", never "Are you sure?".
  • The body says what is lost and what cannot be recovered, with counts where they apply.
  • The buttons are verb plus object, Delete project and Cancel, never Yes and No.
  • For an account, a workspace or a repository, ask the person to type the object's name.

Templates are in patterns.md. The destructive button's distinct color is better-colors'.

Empty states point forward

An empty state says what this place is and how to fill it, and offers one clear next action:

<!-- Bad: a shrug -->
<p>No results.</p>

<!-- Good: orientation plus a next step -->
<p class="font-medium">No projects yet</p>
<p class="text-sm text-zinc-500">Projects keep your tasks and files together.</p>
<button class="mt-4">Create a project</button>

A filtered empty state names the query and offers an exit: "No results for 'quarterly'. Clear filters". Never park persistent information in an empty state. It disappears the moment content exists.

Loading, saving and success copy is in patterns.md.

Placeholders show an example

A placeholder shows a realistic example in the format the field accepts, name@example.com or DD/MM/YYYY, never an instruction. Whether the field also needs a visible label is better-accessibility's.

Before you finish

Detection pattern Fix
Click here, a link reading here or two identical Learn more links Name the destination
Oops, Something went wrong or ! in an error string Say what failed and the next step
" + n + ", a template literal holding a sentence fragment, or === 1 ? "" : "s" One ICU message with a plural argument
>OK<, >Yes< or >No< on a dialog button Verb plus object
Are you sure Name the action and the object
successfully Cut it: "Changes saved"
Please in a routine instruction Cut it
A toggle label starting Don't, Disable or Hide Describe the ON state
aria-label="Trash", "Close icon" or "X" Name the action: "Delete project", "Close dialog"
toLocaleDateString() with no locale, or a date built from getMonth() Intl.DateTimeFormat with the user's locale
Save Changes beside Discard changes One case per element type

Reporting

Severity. HIGH misleads the user or hides how to recover from an error. An error that names no way to recover is always HIGH, as is a destructive action with neither confirmation nor undo. MEDIUM breaks voice, terminology or capitalization consistency. LOW is isolated wording polish.

Verification. Check every label against the action it invokes, every error for a stated fix and every term against the inventory. Read locale files as well as components. Report strings supplied by the server or a CMS that you could not see as Not verified.

Format. Group findings under the principle each violates, ordered by severity, one row per root cause listing every location it appears in:

Severity Location Before After Why

Location is path/to/file:line. Why names the principle and the user impact.

End with Block when any HIGH remains, Approve otherwise, leaving the rest in the table as work to do. Never Approve coverage you did not inspect. With nothing to report, state "No actionable writing findings" and report verification.

Version History

  • 4c66b1f Current 2026-10-18 18:51

    将技能名称从 Interface writing 更新为 Writing,细化了库存现有字符串的步骤,并明确了翻译调用的搜索范围。

  • 267330e 2026-09-02 22:31

    新增技能描述说明

  • ca48385 2026-08-27 10:16

    重构技能结构,将审核输出格式内联至各领域技能以实现独立部署;清理标题大小写和被动语态;拆分长句并移除冗余表述,提升文档清晰度。

  • ba35986 2026-08-16 16:36

    重构标准化了跨技能的审查输出格式,并移除了重复内容。

  • a673333 2026-07-30 20:27

Same Skill Collection

skills/better-accessibility/SKILL.md
skills/better-colors/SKILL.md
skills/better-interface/SKILL.md
skills/better-layout/SKILL.md
skills/better-typography/SKILL.md
skills/better-ui/SKILL.md
skills/break/SKILL.md
skills/build-design/SKILL.md
skills/explain-interface/SKILL.md
skills/interface-review/SKILL.md
skills/state-machine/SKILL.md
skills/technical-drawing/SKILL.md
skills/variant/SKILL.md

Metadata

Files
0
Version
4c66b1f
Hash
ef6843cb
Indexed
2026-07-30 20:27

홈 - 위키
Copyright © 2011-2026 iteam. Current version is 2.155.2. UTC+08:00, 2026-10-21 16:09
浙ICP备14020137号-1