All rules

Section with nothing concrete

concrete-evidence-densityon by default (info)Japanese / English

A section with no number, code or link: nothing for the reader to take away

Example

Flagged
# Improvement report ## Results Our help desk got much better. Customers are pleased with it. The team feels less pressure too.
What chaff prints
3:11 Section "Results" has no number, code or link (1 of 1 section)
Fixed
# Improvement report ## Results Replies to help desk tickets now take 1 day on average, down from 3. Customer satisfaction rose from 72% to 85%. Overtime fell by 10 hours a month.
What chaff prints
no finding
chaff.yaml used for this example
rules: concrete-evidence-density: strict

How to fix

Add one example. If you cannot, the section may belong inside another one.

Why it matters

A section with no number, no code and no link leaves the reader with nothing to take away.

What it does not flag

Sections shorter than three sentences, index-like sections of entries, and sections where at least half the sentences are questions or instructions are not checked.

Turning it off or relaxing it

Silence this one spot (in the document)
<!-- stet: concrete-evidence-density — reason -->
Relax it for the team (the reason is kept as a comment in chaff.yaml)
npx chaffjs relax concrete-evidence-density --why "reason"
Turn it off for the team (chaff.yaml)
rules: concrete-evidence-density: off
Technical details
Layer
L1
Status
stable
Severity
info
Languages
Japanese and English
Suited to
blog, business, 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).

strictreported once 1 sections have nothing concrete
normalreported once 3 sections have nothing concrete
relaxedreported once 6 sections have nothing concrete

By genre

Runs by default in
business/proposal, business/report, business/email, business/press-release
Turned off by the genre in
blog/tech, blog/essay, blog/owned-media, 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
Not suited to, and not run in
technical/spec, technical/readme

Genres

Message

Section "{word}" has no number, code or link ({count} of {total} sections)

This page is built from the rule's definition file:packages/chaff/rules/concrete-evidence-density.yaml