A word spelled differently in different files
cross-doc-term-varianton by default (info)Japanese / English
The same word spelled one way in some files and another way in others
Example
How to fix
Change it to "the other files' spelling". If the team has decided which way, list the pair under prefer in chaff.yaml, and every file is checked against it.
Why it matters
In a manual or a bundle of documents, each file can be consistent on its own while the files disagree with each other: one page writes "e-mail", the others "email". It happens when different people write at different times. A reader wonders whether they are different things, and a site search misses one. The files given together are compared, and a word written one way in some files and another way in the rest is pointed out. Three kinds of spelling are compared: the final ー of a katakana word (サーバ / サーバー), British and American spellings (colour / color), and a Latin word with and without a hyphen (e-mail / email). chaff does not pick a side; it points at the way fewer files use.
What it does not flag
A file that writes a word both ways is not counted for that word (the per-file rules, such as katakana-long-vowel, point at that). Different words are not compared (サーバー and ブラウザ). Katakana words of one mora before the final ー (カー), words the dictionary knows as proper nouns, the names under names in chaff.yaml, spellings inside quotation marks, and capitalized names in mid-sentence are left alone. For hyphens, only words that one of the files writes with a hyphen are compared.
Turning it off or relaxing it
Technical details
- Layer
- L3
- Status
- stable
- Severity
- info
- Languages
- Japanese and English
- Suited to
- business, technical, blog, legal, docs, academic, literature, speech
- Reads from the document
- documents
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 | warning |
|---|---|
| normal | info |
| 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, speech/address, speech/transcript
- Turned off by the genre in
- literature/fiction, literature/essay, literature/poetry, literature/play
Message
"{matched}" here, but "{preferred}" in {count} other files checked with it (as in {other})
This page is built from the rule's definition file:packages/chaff/rules/cross-doc-term-variant.yaml