札と番号だけの見出し
numbered-generic-heading既定で動く(情報)日本語 / 英語
「メリット1」「ポイント2」「Benefit 3」のように、札と番号だけで中身を言わない見出しが並ぶ所
例
指摘される文
# 新しい会議室予約の仕組み
## メリット1
空き状況がすぐ分かります。
## メリット2
予約の取り消しが一度で済みます。
chaff の出力
3:1 見出し「メリット1」は札と番号だけで、節の中身が分かりません(そういう見出しが 2 個)
7:1 見出し「メリット2」は札と番号だけで、節の中身が分かりません(そういう見出しが 2 個)
直した文
# 新しい会議室予約の仕組み
## 空き状況がすぐ分かる
空き状況がすぐ分かります。
## 取り消しが一度で済む
予約の取り消しが一度で済みます。
chaff の出力
指摘なし
直し方
札の後ろに、その節で言うことを書いてください(メリット1 → メリット1:設定が要らない、または 設定が要らない)。
なぜ指摘するのか
「メリット1」「メリット2」「ポイント3」のように札と番号だけの見出しは、目次や見出しの一覧で読んでも、その節に何が書いてあるかが分かりません。読み手は節を開くまで中身を知れず、あとで探すこともできません。型をなぞって書いた文書に多い形です。札は語彙表 generic-heading-label にあり、手順の札(ステップ1)は順番そのものが中身なので入れていません。
指摘しないもの
札の後ろに題を足した見出し(メリット1:設定が要らない)、手順・理由・課題の見出し(ステップ1、理由2、課題3)、章や節の番号(第1章)は、番号で引かれる単位なので指しません。Markdown の見出しだけを読みます。
止める・ゆるめる
この一か所だけ黙らせる(文書に書く)
<!-- stet: numbered-generic-heading — 理由 -->
チームでゆるめる(理由は chaff.yaml にコメントで残ります)
npx chaffjs relax numbered-generic-heading --why "理由"
チームで止める(chaff.yaml)
rules:
numbered-generic-heading: off
技術的な情報
- 層
- L1
- 状態
- 安定
- 重さ
- 情報
- 対象の言語
- 日本語と英語
- 向いている文章
- blog, business, technical, docs, academic, legal, literature, speech
- 文書から読み取るもの
- markdown
強さ(段階)
chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます(どのジャンルで動くかは下の「ジャンルごとの動き」にあります)。
| strict | 札と番号だけの見出しが 1 個から指摘 |
|---|---|
| normal | 札と番号だけの見出しが 2 個から指摘 |
| relaxed | 札と番号だけの見出しが 3 個から指摘 |
ジャンルごとの動き
- 既定で動くジャンル
- 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
指摘の文
見出し「{heading}」は札と番号だけで、節の中身が分かりません(そういう見出しが {count} 個)
書き直しの深さ(chaff fix-plan --depth): structure — 節・見出し・段落を組み替える
このページはルールの定義ファイルから作られています:packages/chaff/rules/numbered-generic-heading.yaml