規定の文末が、決めた書き方と違う
requirement-modalchaff.yaml に書いたとき日本語 / 英語
規格・規程の文末が、チームの選んだ決まり（JIS Z 8301 など）と違う所（選んだときだけ）
例
直し方
文が言っていることが要求・推奨・許容・可能性のどれかを決めて、その形に直してください。推奨なら「…することが望ましい」、許容なら「…してもよい」、可能性なら「…可能である」「…場合がある」です。
なぜ指摘するのか
規格や規程は、要求・推奨・許容を文末の形で書き分けます。読み手は文末で、守らなければならないのか、望ましいだけなのか、してもよいのかを読み取ります。JIS Z 8301:2019 は、推奨に「…すべきである」を、許容と可能性に文末の「…できる」を使わないと決め、「…することが望ましい」「…してもよい」「…可能である」を使います。英語では、米国連邦政府の Plain Language Guidelines が、義務には曖昧な "shall" ではなく "must" を使うとしています。どちらもチームが選ぶ決まりなので、options で決めたときだけ見ます。
指摘しないもの
options で決めなければ何も見ません。「できる」は文の終わりだけを見ます（JIS は能力を示す「できる」を文の途中で使うのを認めています）。
止める・ゆるめる
技術的な情報
- 層
- L2
- 状態
- 安定
- 重さ
- 注意
- 対象の言語
- 日本語と英語
- 向いている文章
- business, technical, blog, legal, docs, academic, literature, speech
強さ（段階）
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
指摘の文
「{matched}」は使わない形です。「{preferred}」と書きます
根拠にした文献
このページはルールの定義ファイルから作られています:packages/chaff/rules/requirement-modal.yaml