Section lengths are too uniform
section-length-uniformityon by default (info)Japanese / English
Every section filled to the same size, which is what a template does
Example
Flagged
# Introducing the new tool
## Install
Pick the version for your computer from the official page.
## Set up
Press the gear icon and choose your language and document type.
## Invite
Enter your team's addresses on the invite page and send.
## Check
Add a sample document and look for findings on the screen.
## Update
When a new version comes out, install it again from the same page.
What chaff prints
1:27 Section length varies by only 6% (want at least 35%)
Fixed
# Introducing the new tool
## Install
Download it from the official page.
## Set up
Press the gear icon and choose your language and document type. There are many options, but at first you only need these two. Change the rest when you need to.
## Invite
Send invites from the page on the left.
## Check
Add a sample document and look for findings on the screen.
## Update
New versions are on the same page.
What chaff prints
no finding
chaff.yaml used for this example
genre: blog/tech
How to fix
Let the thin sections stay thin.
Why it matters
Filling every heading to the same size is what a template does, not what a writer does.
What it does not flag
Documents with fewer than 5 sections are not checked (min_sections changes it). Business and specification (technical/spec) genres do not run this rule.
Turning it off or relaxing it
Silence this one spot (in the document)
<!-- stet: section-length-uniformity — reason -->
Relax it for the team (the reason is kept as a comment in chaff.yaml)
npx chaffjs relax section-length-uniformity --why "reason"
Turn it off for the team (chaff.yaml)
rules:
section-length-uniformity: off
Technical details
- Layer
- L1
- Status
- stable
- Severity
- info
- Languages
- Japanese and English
- Suited to
- technical/readme, 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 | reported when section length varies by less than 45% |
|---|---|
| normal | reported when section length varies by less than 35% |
| relaxed | reported when section length varies by less than 25% |
By genre
- Runs by default in
- technical/readme, blog/tech, blog/essay, blog/owned-media
- Turned off by the genre in
- 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
- Not suited to, and not run in
- technical/spec, business/proposal, business/report, business/email, business/press-release, business/meeting-notes
Message
Section length varies by only {variance}% (want at least {limit}%)
This page is built from the rule's definition file:packages/chaff/rules/section-length-uniformity.yaml