All rules

A required heading is missing

required-sectionswhen listed in chaff.yamlJapanese / English

A heading the team requires (such as "Risks") missing, set in chaff.yaml

Example

Flagged
# Moving to the new accounting system ## Benefits The month closes three days sooner.
What chaff prints
1:1 No heading for "Risks"
Fixed
# Moving to the new accounting system ## Benefits The month closes three days sooner. ## Risks Finance will work longer hours in the month we switch.
What chaff prints
no finding
chaff.yaml used for this example
required_sections: - Risks

How to fix

Add the heading. If it is not needed, the honest fix is to remove it from `required_sections`.

Why it matters

"A proposal has a risk section" is a decision each team makes. chaff holds no list of its own; it only checks the one written under `required_sections` in chaff.yaml. With nothing written, this rule says nothing.

What it does not flag

Only the headings under required_sections in chaff.yaml are checked. A heading that contains the word counts ("Risks" is met by "Risks and mitigations").

Turning it off or relaxing it

Silence this one spot (in the document)
<!-- stet: required-sections — reason -->
Relax it for the team (the reason is kept as a comment in chaff.yaml)
npx chaffjs relax required-sections --why "reason"
Turn it off for the team (chaff.yaml)
rules: required-sections: off
Technical details
Layer
L1
Status
stable
Severity
error
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).

strictreported once 1 required headings are missing
normalreported once 1 required headings are missing
relaxedreported once 2 required headings are missing

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

No heading for "{word}"

This page is built from the rule's definition file:packages/chaff/rules/required-sections.yaml