太字の札で始まる箇条書きが多い
bold-label-list既定で動く(情報)日本語
「- **速さ**:〜」のように、太字の札とコロンで始まる項目が並び、説明が札の続きだけになっている所
例
指摘される文
# 新しい在庫システム
- **速さ**:一覧が 1 秒で出ます。
- **正確さ**:数え間違いが減ります。
- **安さ**:月の費用が下がります。
- **使いやすさ**:画面が分かりやすくなりました。
- **安全**:権限を細かく分けられます。
chaff の出力
3:1 「速さ」など、太字の札で始まる項目が 5 個あります(5 個から)
直した文
# 新しい在庫システム
一覧は 1 秒で出るようになり、数え間違いも減りました。
月の費用は下がり、権限も細かく分けられます。
chaff の出力
指摘なし
この例で使った chaff.yaml
genre: blog/tech
直し方
札を外して、項目を文にしてください。大事な項目が 1 つ 2 つなら、それを段落で書き、残りは消すか 1 文にまとめます。用語集のように、本当に札と説明の組を並べるものはそのままでかまいません。
なぜ指摘するのか
「- **速さ**:〜」のように、項目ごとに太字の札とコロンを置いて説明を続ける形です。札が並ぶと、どの項目も同じ重さの見出しに見え、項目どうしの繋がりは書かれません。生成文によく見られる形です。
指摘しないもの
札がコードだけの項目(`--flag` の説明のような、設定や引数の一覧)は数えません。札の後ろにコロンが無い項目と、コロンの後ろに何も無い項目も数えません。仕様書(technical/spec)・法務・説明書・論文・文学のジャンルでは見ません。英語の文書は、人もよくこの形で書くので見ません。
止める・ゆるめる
この一か所だけ黙らせる(文書に書く)
<!-- stet: bold-label-list — 理由 -->
チームでゆるめる(理由は chaff.yaml にコメントで残ります)
npx chaffjs relax bold-label-list --why "理由"
チームで止める(chaff.yaml)
rules:
bold-label-list: off
技術的な情報
- 層
- L1
- 状態
- 安定
- 重さ
- 情報
- 対象の言語
- ja
- 向いている文章
- technical/readme, blog, business, legal, docs, academic, literature, speech
- 文書から読み取るもの
- markdown
強さ(段階)
chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます(どのジャンルで動くかは下の「ジャンルごとの動き」にあります)。
| strict | 太字の札で始まる項目が 3 個あれば指摘 |
|---|---|
| normal | 太字の札で始まる項目が 5 個あれば指摘 |
| relaxed | 太字の札で始まる項目が 8 個あれば指摘 |
ジャンルごとの動き
- 既定で動くジャンル
- technical/readme, blog/tech, blog/essay, blog/owned-media, business/proposal, business/report, business/email, business/press-release, speech/address
- このルールを止めるジャンル
- 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/transcript
- このルールが向かず、見ないジャンル
- technical/spec
指摘の文
「{label}」など、太字の札で始まる項目が {count} 個あります({limit} 個から)
書き直しの深さ(chaff fix-plan --depth): structure — 節・見出し・段落を組み替える
根拠にした文献
このページはルールの定義ファイルから作られています:packages/chaff/rules/bold-label-list.yaml