ルールの一覧へ

大文字だけの語の連なり(叫び)

all-caps-shouting既定で動く(情報)英語

英語で、「DO NOT DELETE THIS」のように普通の語を大文字だけで続けた所

例

指摘される文
Do not delete the log. DO NOT DELETE THIS FILE before the audit.
chaff の出力
1:24 "DO NOT DELETE THIS FILE" is written in capitals
直した文
Do not delete the log. Do not delete this file before the audit.
chaff の出力
指摘なし

直し方

普通の大文字小文字で書き、強めたいなら太字にするか、なぜ大事なのかを書いてください。

なぜ指摘するのか

英語の本文で、「DO NOT DELETE THIS」のように普通の語を大文字だけで三つ以上続けると、叫んでいるように読め、大文字の語は読む速さも落ちます。略語の並び(AWS IAM SSO)と区別するため、半分以上の語が文書のほかの所で小文字でも書かれているときだけ指します。

指摘しないもの

三語以上の連なりだけを見ます。略語の並び(文書のほかの所で小文字で書かれない語)とコードは見ません。仕様書の MUST や SHALL は慣習の大文字として数えません。段落の頭に置いた大文字の見出し語(「AGENCY:」「WORKING GROUP MEMBERS」のように、コロンで終わるか一行で段落になるもの)と、本文でその見出し語を挙げた所も見ません。全部の行が大文字で文で終わらない段落(「BOARD OF GOVERNORS」で始まるレターヘッドや宛名、議事録が一行で立てる「OPENING STATEMENT OF HON. JANE DOE,」のような見出し)と、名簿の欄の「JANE Q. DOE, Ohio」のように大文字の名前の後ろに普通の書き方の地名や役職が続くものも見ません。法令と文学の文書では既定で止めています(大文字で目立たせる決まりや、題を大文字で組む慣習があるため)。

止める・ゆるめる

この一か所だけ黙らせる(文書に書く)
<!-- stet: all-caps-shouting — 理由 -->
チームでゆるめる(理由は chaff.yaml にコメントで残ります)
npx chaffjs relax all-caps-shouting --why "理由"
チームで止める(chaff.yaml)
rules: all-caps-shouting: off
技術的な情報
層
L1
状態
安定
重さ
情報
対象の言語
en
向いている文章
business, technical, blog, legal, docs, academic, literature, speech

強さ(段階)

chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます(どのジャンルで動くかは下の「ジャンルごとの動き」にあります)。

strict1 箇所あれば指摘
normal1 箇所あれば指摘
relaxed2 箇所あれば指摘

ジャンルごとの動き

既定で動くジャンル
technical/spec, technical/readme, blog/tech, blog/essay, blog/owned-media, business/proposal, business/report, business/email, business/press-release, business/meeting-notes, docs/manual, docs/faq, docs/glossary, academic/paper, speech/address, speech/transcript
このルールを止めるジャンル
legal/contract, legal/statute, legal/judgment, legal/patent, literature/fiction, literature/essay, literature/poetry, literature/play

ジャンル

指摘の文

「{matched}」を大文字だけで書いています

書き直しの深さ(chaff fix-plan --depth): light — 語と文を直す。構成と文体は残す

このページはルールの定義ファイルから作られています:packages/chaff/rules/all-caps-shouting.yaml