することの書かれていない注意書き
warning-without-action既定で動く（情報）日本語 / 英語
「注意」「警告」で始まる段落で、危険だけを書き、読み手のすること（〜してください、〜しないこと）が無いもの
例
直し方
危険を避けるために読み手がすることを、同じ段落に書き足してください（「先に〜を書き出してください」「〜の間は電源を切らないでください」）。
なぜ指摘するのか
「注意：復元すると、今のデータベースは置き換わります。」のように危険だけを書いた注意書きは、読み手を不安にするだけで、何をすれば防げるのかを教えません。手順書の注意書きは、何が起きるかと、それを防ぐために読み手がすること（先に書き出す、電源を切らない）を一緒に書くものです。「注意」「警告」「危険」で始まる段落の、どの文にも「〜してください」「〜しないこと」のような読み手のすることが無いとき指します。
指摘しないもの
「注意」「警告」「危険」をそれだけで頭に置いた段落（「注意：」「**警告**」「> [!WARNING]」）だけを読みます。GitHub の注意（> [!WARNING]）は引用の終わりまでを一つの注意書きとして読みます。箇条書きの項目の中の注意書き、「メモ」「ヒント」「重要」の段落、「注意深く」のように語の一部になったもの、どれかの文が読み手のすること（〜してください、〜しないこと、〜する必要があります）で終わる注意書きは指しません。技術文書・手順書・ブログでだけ動きます。
止める・ゆるめる
技術的な情報
- 層
- L3
- 状態
- 安定
- 重さ
- 情報
- 対象の言語
- 日本語と英語
- 向いている文章
- technical, docs, blog, legal, academic, literature, speech
強さ（段階）
chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます（どのジャンルで動くかは下の「ジャンルごとの動き」にあります）。
| strict | 注意 |
|---|---|
| normal | 情報 |
| relaxed | 情報 |
このルールには数える上限がありません。段階は指摘の重さを変えます。relaxed にすると指摘は消えずに一段軽く出ます。
ジャンルごとの動き
- 既定で動くジャンル
- technical/spec, technical/readme, blog/tech, blog/essay, blog/owned-media, docs/manual, docs/faq, docs/glossary
- このルールを止めるジャンル
- legal/contract, legal/statute, legal/judgment, legal/patent, academic/paper, literature/fiction, literature/essay, literature/poetry, literature/play, speech/address, speech/transcript
- このルールが向かず、見ないジャンル
- business/proposal, business/report, business/email, business/press-release, business/meeting-notes
指摘の文
この注意書きは危険を述べるだけで、読み手がすることを書いていません
このページはルールの定義ファイルから作られています:packages/chaff/rules/warning-without-action.yaml