All rules

Screen label written two ways

ui-label-varianton by default (info)Japanese / English

A screen label written two ways that differ only in case, spacing or a particle

Example

Flagged
# Restore Click **Start Restore**. If nothing happens, click **Start Restore** again. If it fails, select the previous backup and click **Start restore**.
What chaff prints
5:53 "Start restore" is written as "Start Restore" elsewhere
Fixed
# Restore Click **Start Restore**. If nothing happens, click **Start Restore** again. If it fails, select the previous backup and click **Start Restore**.
What chaff prints
no finding
chaff.yaml used for this example
genre: docs/manual

How to fix

Check the screen and use its spelling in every step.

Why it matters

When a manual writes the same button as **Start Restore** in one step and **Start restore** in another, the reader looks for two buttons. A manual spells every label exactly as the screen does. It happens when the screen's wording changes and only some steps are updated. Labels in bold (or in ［］) that differ only in case, spaces or a particle are read as one label, and the form written less often is pointed out.

What it does not flag

Only labels in bold or in ［］ are compared. Quoted words, code, labels with different words (**Save** and **Save As**), and emphasis differing only in its first letter's case (**Note** and **note**) are not. Technical documents, manuals and blogs only.

Turning it off or relaxing it

Silence this one spot (in the document)
<!-- stet: ui-label-variant — reason -->
Relax it for the team (the reason is kept as a comment in chaff.yaml)
npx chaffjs relax ui-label-variant --why "reason"
Turn it off for the team (chaff.yaml)
rules: ui-label-variant: off
Technical details
Layer
L3
Status
stable
Severity
info
Languages
Japanese and English
Suited to
technical, docs, blog, legal, academic, literature, speech

Levels

Set a level for this rule under rules in chaff.yaml. With nothing set, it runs at the level its genre gives it (see By genre below).

strictwarning
normalinfo
relaxedinfo

This rule has no limit to count to. A level sets how a finding is marked: relaxed keeps the finding and marks it a step lower.

By genre

Runs by default in
technical/spec, technical/readme, blog/tech, blog/essay, blog/owned-media, docs/manual, docs/faq, docs/glossary
Turned off by the genre in
legal/contract, legal/statute, legal/judgment, legal/patent, academic/paper, literature/fiction, literature/essay, literature/poetry, literature/play, speech/address, speech/transcript
Not suited to, and not run in
business/proposal, business/report, business/email, business/press-release, business/meeting-notes

Genres

Message

"{written}" is written as "{usual}" elsewhere

This page is built from the rule's definition file:packages/chaff/rules/ui-label-variant.yaml