無い手順を指す参照
step-reference-missing既定で動く日本語 / 英語
「手順5を参照」のように、文書の手順の最後の番号を超える手順を指す参照
例
指摘される文
1. アプリを開きます。
2. 設定を選びます。
3. 保存します。
うまくいかないときは、手順4からやり直してください。
chaff の出力
5:12 「手順4」を指していますが、手順は 3 までです
直した文
1. アプリを開きます。
2. 設定を選びます。
3. 保存します。
うまくいかないときは、手順2からやり直してください。
chaff の出力
指摘なし
直し方
指したい手順の番号を確かめて、参照を直してください。手順を消したのなら、参照の文も直します。
なぜ指摘するのか
「手順5を参照」と書いたのに手順が4つしか無ければ、読み手は手順5を探して手を止めます。手順を減らしたり並べ替えたりしたあとに、本文の参照だけが古い番号のまま残ると起きます。手順の番号と参照の番号を突き合わせれば、機械で言えます。
指摘しないもの
手順は、手順の語（手順、ステップ、Step）と番号で始まる見出しと、番号付きの箇条書きの項目です。手順が一つも無い文書の参照は、ほかの文書の手順かもしれないので言いません。番号付きの箇条書きがいくつかあれば、いちばん大きい番号を超える参照だけを言います。コードの中は読みません。
止める・ゆるめる
この一か所だけ黙らせる（文書に書く）
<!-- stet: step-reference-missing — 理由 -->
チームでゆるめる（理由は chaff.yaml にコメントで残ります）
npx chaffjs relax step-reference-missing --why "理由"
チームで止める（chaff.yaml）
rules:
step-reference-missing: off
技術的な情報
- 層
- L3
- 状態
- 安定
- 重さ
- 注意
- 対象の言語
- 日本語と英語
- 向いている文章
- business, technical, blog, legal, docs, academic, literature, speech
強さ（段階）
chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます（どのジャンルで動くかは下の「ジャンルごとの動き」にあります）。
| 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}」を指していますが、手順は {last} までです
このページはルールの定義ファイルから作られています:packages/chaff/rules/step-reference-missing.yaml