All skills
bitwarden avatar

/content-style-guide

@44910a0 official
by bitwardenbitwarden/ai-plugins155 stars
20

Bitwarden's product content style guide for end-user-facing GUI copy — voice, tone, AP-style-with-exceptions grammar, sentence case in UI, and accessibility-first language at a U.S. 7th-grade reading level.

Use this Skill: https://skilld.dev/gh/bitwarden/ai-plugins/content-style-guide

This session only. Nothing lands on disk.

referencesaccessibility-rules.md

≈880 tokens on demand. Your agent reads this file only when SKILL.md points to it.

Writing for Accessibility and Inclusivity

These rules are first-class — apply alongside grammar and mechanics whenever copy is being reviewed or written. Bitwarden's users include people using assistive technology, non-native English speakers, and people with cognitive differences. Copy that ignores them is incomplete.

Write simply and directly

Target a U.S. 7th-grade reading level. Short sentences and paragraphs. Active voice. Simple verb tenses. Avoid adverbs and adjectives.

  • Good: Delete file
  • Avoid: Would you like to delete this file?

Exception: in UI where the verb focus should be the object — e.g., "The file was saved."

Create scannable layouts

Follow header hierarchy (H1, H2, H3, H4) — don't skip levels. Assistive tech relies on this. If a level is skipped, users assume they missed a section.

  • Good: [H2] File types → [H3] Images
  • Avoid: [H2] File types → [H4] Images

Paragraph text 16 pt or larger. Line height 1.5×. Space after paragraphs 2× the font size. Use bulleted/numbered lists where appropriate.

Consider non-English and ESL speakers

Avoid idioms, phrases, and emojis that don't translate well. Treat them as decorative — acceptable for zest, but not load-bearing for meaning.

  • Good: Nice job
  • Avoid: Hats off to you

Spell out acronyms

Never assume the reader knows the acronym. Spell out at first reference per page, with the acronym in parentheses. Then use only the acronym.

Don't imply tasks are easy or simple

Tasks aren't equally easy for everyone — assistive tech, cognitive ability, and environment all affect speed. Give helpful information instead.

  • Good: Follow these three steps.
  • Avoid: Follow these fast, easy steps.

Use text styling sparingly

Italics, bold, and ALL CAPS are harder to read. Screen readers don't always identify font styles. Don't apply to full paragraphs.

Always left-align paragraph text. Justified and center-aligned text is harder for people with dyslexia.

Avoid spatial language

Use time-based ("next", "before") or element-based ("in the dropdown") directions, not spatial ("above", "below", "on the left"). Spatial directions confuse screen reader users.

  • Good: In the global menu
  • Avoid: In the top left corner of the screen

Focus on critical info in alt text

If a visual conveys information, describe it in alt text, caption, or paragraph text. Keep alt text under 125 characters where possible. Don't write "image of" — repetitive with screen readers.

If the visual isn't critical:

  • Write short alt text so users know what's there but can move on, OR

  • Leave alt blank and add aria-hidden="true" so screen readers skip it.

  • Good: search results for airplanes

  • Avoid: image of search results for the keyword phrase "airplanes" which includes 63 images and PDF documents and the download button circled

Write meaningful link text

Link text should tell the user what they're clicking or where they'll go. Don't write "Click here." Screen reader users may jump from link to link.

  • Good: Read this article about integrations.
  • Avoid: Click here to learn more about integrations.

Don't add a separate "Learn more" sentence — usually repetitive.

  • Good: Turn on the new vault feature.
  • Avoid: The new vault feature is now available. Learn more about the feature and how to turn it on.

Always underline link text so colorblind users can see it.

Stay gender neutral

Use they or you instead of gendered pronouns like he/she.

Source: SKILL.md on GitHub

No alerts3mo3 checks · Risk SAFE
  • Gen Agent Trust Hub3mo

    This skill consists entirely of documentation and guidelines for content style and accessibility. It contains no executable code, network operations, or dangerous instructions.

  • Socket3mo

    No alerts

  • Snyk3mo

    Risk: LOW · No issues

Signed by skilld at 44910a0. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated 4 months ago
All 1 allowed tools
Skill
Other metadata
when_to_use
Use when end-user-facing GUI strings are being authored or critiqued — button labels, error messages, toasts, modal copy, onboarding, empty states, form labels, helper text, link text. Triggers — "review this copy", "is this error message ok", "rewrite this button label", "check the wording", "what should this say". Composed by `design-review` at 60%/90% stages and by `figma-to-angular` (external, not bundled) during code generation. Not for developer-facing strings, code comments, design tokens, or marketing/long-form content.
  • content-style-guide
  • gui-copy
  • voice-and-tone
  • accessibility
  • bitwarden
  • ui-writing
  • grammar
  • localization

README badge

README badge for bitwarden/ai-plugins/content-style-guide

Guides AI agents to write and review end-user-facing GUI copy — button labels, error messages, modals, onboarding — using Bitwarden's voice (approachable, encouraging, transparent), tone rules (formal/casual, matter-of-fact/enthusiastic depending on context), and accessibility-first grammar at a U.S. 7th-grade reading level. Apply only to product UI strings, not code comments, design tokens, or marketing content.

Generated from the current SKILL.md.

Does this skill apply to code comments and developer-facing strings?
No. This skill covers end-user-facing GUI copy only — button labels, error messages, modals, onboarding text, and similar. It does not apply to code comments, design tokens, or internal developer strings.
What reading level should GUI copy target?
U.S. 7th-grade reading level. The skill includes accessibility rules in `references/accessibility-rules.md` that specify directness, scannable layouts, and avoiding condescending framings like 'easy' or 'simple'.
Should error messages use casual or formal tone?
Formal and matter-of-fact. Error states should be serious and respectful, avoiding humor or fluff — for example, 'An error occurred. Please try again.' rather than 'Uh oh! We goofed.'
When should I apply this skill during design critiques?
Include content observations at 60% and 90% stages alongside visual feedback. Skip content nitpicks at 30% — the copy will likely change. Frame feedback tied to user and product goals, not personal taste.
Does this skill rewrite copy automatically, or does it ask first?
It asks first. When the skill surfaces a violation (e.g., title-case button text), it proposes compliant alternatives and lets the user choose, rather than silently rewriting.

Generated from the current SKILL.md. These answers refresh after source changes.