Words that only work inside
internal-jargonwhen listed in chaff.yamlJapanese / English
Words that only work inside your team, from jargon in chaff.yaml
Example
How to fix
Use ordinary words, or explain it in brackets at first use. A verb entered in its dictionary form also finds its other forms; a stem works too.
Why it matters
A word that works inside one team does not work outside it, or six months later. Which words those are differs by team, so list them under `jargon` in chaff.yaml. With nothing listed, this rule says nothing.
What it does not flag
Only the words under jargon in chaff.yaml are checked. With nothing listed, it says nothing.
Turning it off or relaxing it
Technical details
- Layer
- L2
- Status
- stable
- Severity
- warning
- Languages
- Japanese and English
- Suited to
- business, blog, technical, 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 | reported once there are 1 |
|---|---|
| normal | reported once there are 1 |
| relaxed | reported once there are 3 |
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
Message
"{matched}" may only be understood inside your team ({count} such words)
This page is built from the rule's definition file:packages/chaff/rules/internal-jargon.yaml