「第2章で述べた〇〇」の〇〇が、第2章に無い
reference-topic-missing既定で動く(情報)日本語 / 英語
「第2章で述べた料金体系」のように参照先の話題を書いたのに、その章に話題の語が無い所
例
指摘される文
# 案内
## 第1章 総則
第2章で述べた返金手続は改定されます。
## 第2章 料金
料金体系は月額です。
chaff の出力
5:1 第2章(料金)に「返金手続」が見当たりません
直した文
# 案内
## 第1章 総則
第2章で述べた料金体系は改定されます。
## 第2章 料金
料金体系は月額です。
chaff の出力
指摘なし
直し方
話がどの章にあるかを確かめて、参照の番号を直してください。言い換えて書いているなら、同じ言葉に揃えると読み手が探せます。
なぜ指摘するのか
「第2章で述べた料金体系」と書いたのに、第2章に料金体系の話が無いと、読み手は探しても見つけられません。章を入れ替えたり、話を別の章へ移したりしたときに起きます。参照のすぐ後ろの「で述べた」「で説明した」に続く語を、参照先の見出しと本文から探し、どこにも無ければ指します。
指摘しないもの
「詳細」「内容」のようにどの章にも当てはまる語、参照先が見出しを持たないか一つに決まらない参照、他の文書の条は見ません。言い換え(料金と価格)は見つけられないので、語が違えば指します。
止める・ゆるめる
この一か所だけ黙らせる(文書に書く)
<!-- stet: reference-topic-missing — 理由 -->
チームでゆるめる(理由は chaff.yaml にコメントで残ります)
npx chaffjs relax reference-topic-missing --why "理由"
チームで止める(chaff.yaml)
rules:
reference-topic-missing: off
技術的な情報
- 層
- L3
- 状態
- 安定
- 重さ
- 情報
- 対象の言語
- 日本語と英語
- 向いている文章
- business, technical, blog, legal, docs, academic, literature, speech
- 文書から読み取るもの
- structure
強さ(段階)
chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます(どのジャンルで動くかは下の「ジャンルごとの動き」にあります)。
| strict | 注意 |
|---|---|
| normal | 情報 |
| relaxed | 情報 |
このルールには数える上限がありません。段階は指摘の重さを変えます。relaxed にすると指摘は消えずに一段軽く出ます。
ジャンルごとの動き
- 既定で動くジャンル
- 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
指摘の文
{label}({heading})に「{topic}」が見当たりません
書き直しの深さ(chaff fix-plan --depth): light — 語と文を直す。構成と文体は残す
このページはルールの定義ファイルから作られています:packages/chaff/rules/reference-topic-missing.yaml