Abbreviation expanded two ways

acronym-expansion-conflicton by defaultJapanese / English

The same abbreviation spelled out as two different names in one document

Example

Flagged

We review the Service Level Agreement (SLA) every month. After an outage, refunds follow the Support Level Agreement (SLA).

What chaff prints

1:118 "SLA" is expanded as "Support Level Agreement" here and as "Service Level Agreement" on line 1

Fixed

We review the Service Level Agreement (SLA) every month. After an outage, refunds follow the SLA.

What chaff prints

no finding

How to fix

Check which name is right and use it in both places. If they are different things, give them different abbreviations.

Why it matters

An abbreviation spelled out as two different names leaves the reader unsure whether they are the same thing. One of them is usually a slip, or a sentence pasted from another document.

What it does not flag

Differences of case, hyphens and a final plural s are not counted. An English name counts as an expansion only when its initials spell the abbreviation. The bracket after a code joined by hyphens or slashes (CC BY-NC-SA (Attribution-NonCommercial-ShareAlike)) names the whole code, not its last abbreviation.

Turning it off or relaxing it

Silence this one spot (in the document)

Relax it for the team (the reason is kept as a comment in chaff.yaml)

npx chaffjs relax acronym-expansion-conflict --why "reason"

Turn it off for the team (chaff.yaml)

rules: acronym-expansion-conflict: off

Technical details

Layer: L3
Status: stable
Severity: warning
Languages: Japanese and English
Suited to: business, technical, blog, legal, docs, 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).

strict	error
normal	warning
relaxed	info

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, business/proposal, business/report, business/email, business/press-release, business/meeting-notes, legal/contract, legal/statute, legal/judgment, legal/patent, docs/manual, docs/faq, docs/glossary, academic/paper, literature/fiction, literature/essay, literature/poetry, literature/play, speech/address, speech/transcript

Genres

Message

"{acronym}" is expanded as "{name}" here and as "{first}" on line {firstLine}

Rewrite depth (chaff fix-plan --depth): light — words and sentences; the structure and the voice stay

This page is built from the rule's definition file:packages/chaff/rules/acronym-expansion-conflict.yaml