agentleFS
fracazofracazo/design-system/skills/writing/SKILL.md

writing

Skill4 starsChanged 53 days agoMITView on GitHub

UX writing and interface copy, from voice and button labels to error messages and empty states. Use when writing or reviewing any user-facing text: button and link labels, form errors, placeholders, settings labels, onboarding flows, notifications, or empty states. Triggers on UX writing, microcopy, interface copy, product copy, copywriting, button labels, link text, error messages, empty states, placeholder text, settings labels, capitalization, title case, sentence case, voice and tone.

51 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use addskill, apply-firmware and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • ryanportfolioSkill

    addskill

    Create, import, update, or install repo or personal skills: runtime ownership, resources, discovery checks.

    Also in 6 projects that use this

  • ryanportfolioSkill

    apply-firmware

    Bring current folder (plain folder, existing repo, old or partial firmware copy) up to full Harness Firmware in place. Mirror external repo → adopt-repo.

    Also in 6 projects that use this

  • +10 more from ryanportfolio

The file

We split this skill into the rules it gives an agent

4 rules. 0 are common, 2 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 45 edited versions we read keep these.

  • 2

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    No blame, no "oops", no exclamation marks.

    line 68
  2. Distinctive:

    Search and filter empty states name the query and offer an exit: "No results for 'quarterly'.

    line 84
  3. Very specific:

    Use this format only when the user asks for a standalone writing review.

    line 121
  4. Very specific:

    When there are no findings, omit the tables, state "No actionable writing findings", report verification, and end with Approve.

    line 157

“Common” is measured: kept by at least 6 in 10 of the 45 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Writing that disappears into the interface

Clear and brief beats clever, consistency beats variety, and the best error message is the interaction redesigned so the error can't happen. Apply these principles when writing or reviewing any user-facing text.

How copy renders (capitalization via text-transform, truncation, smart punctuation) is covered by the typography skill; error markup and announcements (aria-invalid, live regions) by the accessibility skill; room for translated strings by the layout skill. Rendered-pair contrast is colors. Radius, shadow and motion are ui. This skill does not own those domains.

Core Principles

1. Recon the Existing Voice

Before writing or reviewing, inspect nearby interface copy, the product's terminology, localization conventions, and any voice or content style guide. Preserve intentional brand character when it remains clear and appropriate to the stakes. Treat a difference from generic plain language as a finding only when it creates inconsistency, ambiguity, translation risk, or an inappropriate tone.

2. One Voice, Flexible Tone

The product has one voice, established by its existing system rather than invented during a local edit. Keep terms consistent: if it's "Archive" in the menu, it isn't "Move to storage" in the toast. Tone flexes with the stakes:

ContextTone
Success, onboarding, empty statesWarm, can be light
Routine actions, settingsNeutral, minimal
Errors, destructive confirmationsCalm, plain, zero playfulness
Data loss, securitySerious, explicit

3. Address the Reader Directly

In instructional interface copy, address the reader directly as "you" rather than "the user." Avoid “we” in errors when it creates ambiguity or reads as deflection: prefer “Unable to load content” over “We're having trouble loading this content.” Preserve an established first-person brand voice in low-stakes contexts when it remains clear. Use possessives sparingly (“Favorites” over “Your Favorites”) and never switch perspective accidentally.

4. Plain Words Over Clever Ones

Choose easily understood words and delete every word that isn't needed. No idioms, colloquialisms, or 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. Never build sentences by concatenating fragments around variables ("You have " + n + " new messages"); word order changes per language, so use full templated strings with proper pluralization.

5. Verb-First Buttons

Button labels start with a verb naming the specific action: "Send", "Save draft", "Delete project". Never "OK!", "Let's go!", or bare "Yes"/"No" on consequential actions. Confirmation buttons repeat the consequence so the dialog is answerable without reading the body: "Delete this project?" offers Delete project and Cancel, not Yes and No.

6. Consistent Flow Vocabulary

Multi-step flows use one vocabulary: "Get Started" to enter, "Continue" or "Next" (pick one) to advance, "Done" to finish. Alternating synonyms across steps makes users wonder if the buttons do different things.

7. Links Describe Their Destination

Link text makes sense out of context; screen-reader users navigate by a list of the page's links. "Read the billing docs", never "Click here" (which also fails the device-verb rule on touch), and never a bare "Learn more" when several appear on one page. Suffix each: "Learn more about exports".

8. One Capitalization Policy

Pick title case or sentence case per element type (all buttons, all headings) and apply it consistently; sentence case is the safer default: calmer, no per-word case rules, localizes cleanly. "Save Changes" beside "Discard changes" reads as sloppiness.

9. Settings Describe the ON State

Label a toggle for what happens when it's on: "Send read receipts", and users infer the off state. Never label the negative ("Don't send read receipts"), which turns the toggle into a double negative. Link directly to a referenced setting instead of describing the path to it: a "Notification settings" link, not "Go to Settings > Notifications > Email".

10. Errors Say How to Fix, Next to Where It Broke

An error is an instruction, adjacent to the failing field:

BadGood
That password is too shortChoose a password with at least 8 characters
Invalid nameUse only letters for your name
Oops! Something went wrong.Unable to save. Check your connection and try again.

No blame, no "oops", no exclamation marks. Phrase hints positively ("Use only letters", not "Don't use numbers or symbols") and show them before the mistake, not after. If the same error keeps firing for many users, redesign the interaction instead of rewording it.

11. Empty States Point Forward

An empty state says what this place is and how to fill it, with 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>

Search and filter empty states name the query and offer an exit: "No results for 'quarterly'. Clear filters". Never park crucial persistent information in an empty state; it disappears the moment content exists.

12. Placeholders Are Examples, Not Labels

Placeholders show the expected format (name@example.com, DD/MM/YYYY). A placeholder is never the field's only label: it vanishes on input, and every field keeps a visible label.

13. Plain Words, Not Machine-Written Ones

Voice lives in the product's own guide. These patterns mark text as machine-written in any product, and they are findings:

  • Hedging and throat-clearing openers: "it's worth noting", "in today's", "as an AI", "great question", "certainly".
  • Rhetorical scaffolding: "not just X, but Y", "X isn't Y, it's Z", tricolons used as a default rhythm, a question the text then answers itself.
  • Inflated verbs and adjectives: "delve", "leverage", "utilise", "robust", "streamline", "elevate", "harness", "navigate" (when it is not navigation), "landscape", "tapestry", "journey". Also "seamless", "empower", "unlock", "cutting-edge", "revolutionise".
  • Agent jargon in product copy: "agentic", "orchestrate", "surface" as a verb, "spin up".
  • Closing offers and sign-offs: "let me know if", "I hope this helps", "feel free to".
  • Emoji in interface copy or as list markers. Exclamation marks outside genuinely celebratory copy.

Common Mistakes

MistakeFix
Local rewrite ignores the product's established terminology or voiceInspect nearby copy and the style guide before proposing a change
"The user" in instructional interface copyAddress the reader directly as "you"
"We're having trouble…" obscures responsibility or recoveryUse a direct status and next step: "Unable to load content"
OK / Yes confirming a destructive dialogRepeat the consequence: "Delete project"
"Continue" on step 2, "Next" on step 3One flow vocabulary throughout
"Click here" or bare "Learn more" linkDescribe the destination: "Read the billing docs"
"Save Changes" beside "Discard changes"One capitalization policy per element type
"Don't send read receipts" toggleLabel the ON state: "Send read receipts"
"Oops! Something went wrong."Say what to do, next to the failing field
"No results." as the whole empty stateOrient and point forward with a next action
Placeholder doing the label's jobVisible label; placeholder shows the format
"It's worth noting that this is seamless"Say the fact in plain words
"You have " + n + " messages"Full templated strings with pluralization

Review Output Format

Use this format only when the user asks for a standalone writing review. When interface orchestrates the review, provide domain evidence and findings to that skill and let its output format, severity scale, consolidation rules, cap, and verdict take precedence.

Present the standalone review in two parts.

Findings

Group all confirmed findings by principle. Use a markdown table with Severity, Location, Before, After, and Why columns. Never use separate "Before:" / "After:" lines.

  • Severity: HIGH misleads users, obscures a consequence, or prevents recovery; MEDIUM makes a task harder to understand; LOW is isolated voice or consistency polish.
  • Location: cite path/to/file:line. If the artifact has no source files, cite the exact screen and component instead.
  • Before / After: quote the current copy and its complete replacement.
  • Why: name the violated principle and explain the comprehension or trust cost.

Consolidate a repeated systemic issue into one row and list every affected location. Omit principles with no findings.

Example

Errors say how to fix

SeverityLocationBeforeAfterWhy
MEDIUMsrc/PasswordField.tsx:36"Invalid password""Choose a password with at least 8 characters"The error must say how to fix the problem
HIGHsrc/Editor.tsx:81"We couldn't process your request" toastInline "Unable to save. Check your connection and try again."The current message neither locates the failure nor offers recovery

Verb-first buttons

SeverityLocationBeforeAfterWhy
HIGHsrc/DeleteDialog.tsx:29"OK" on the delete confirmation"Delete project"A consequential action must repeat the consequence
MEDIUMsrc/Signup.tsx:54"Let's go!""Create account"The label must name the action

Verification and Verdict

After the findings:

  1. Verification: list the exact checks run and their observed results, including the complete flow, variable interpolation, pluralization, and narrow-width wrapping when applicable. If a check was not run, state what still needs verification.
  2. Verdict: Block if any HIGH finding remains, Needs changes if only MEDIUM or LOW findings remain, and Approve only when no actionable findings remain.

When there are no findings, omit the tables, state "No actionable writing findings", report verification, and end with Approve.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.