必要な見出しが無い
required-sectionschaff.yaml に書いたとき日本語 / 英語
チームが必須と決めた見出し（「リスク」「費用」など）が無い文書。chaff.yaml で決めます
例
指摘される文
# 新しい会計の仕組みへの切り替え
## 効果
月末の締めが三日早くなります。
chaff の出力
1:1 「リスク」の見出しがありません
直した文
# 新しい会計の仕組みへの切り替え
## 効果
月末の締めが三日早くなります。
## リスク
切り替えの月は、経理部の残業が増えます。
chaff の出力
指摘なし
この例で使った chaff.yaml
required_sections:
- リスク
直し方
その見出しを足してください。要らないと思うなら、chaff.yaml の required_sections から外すのが筋です。
なぜ指摘するのか
「提案書にはリスクの節がある」のような取り決めは、組織ごとに違います。chaff は必須の見出しを持たず、chaff.yaml の required_sections に書かれた取り決めを守れているかだけを見ます。書いていなければ何も言いません。
指摘しないもの
chaff.yaml の required_sections に書いた見出しだけを見ます。見出しの一部に含まれていれば満たします（「リスク」は「リスクと対策」でも満たす）。
止める・ゆるめる
この一か所だけ黙らせる（文書に書く）
<!-- stet: required-sections — 理由 -->
チームでゆるめる（理由は chaff.yaml にコメントで残ります）
npx chaffjs relax required-sections --why "理由"
チームで止める（chaff.yaml）
rules:
required-sections: off
技術的な情報
- 層
- L1
- 状態
- 安定
- 重さ
- エラー
- 対象の言語
- 日本語と英語
- 向いている文章
- business, blog, technical, legal, docs, academic, literature, speech
強さ（段階）
chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます（どのジャンルで動くかは下の「ジャンルごとの動き」にあります）。
| strict | 無い見出しが 1 個あれば指摘 |
|---|---|
| normal | 無い見出しが 1 個あれば指摘 |
| relaxed | 無い見出しが 2 個あれば指摘 |
ジャンルごとの動き
- 既定で動くジャンル
- 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
指摘の文
「{word}」の見出しがありません
このページはルールの定義ファイルから作られています:packages/chaff/rules/required-sections.yaml