ルールの一覧へ

略語が説明なしで出てくる

undefined-acronym既定で動く（情報）日本語 / 英語

「KGI」「PMF」のように、説明なしで出てくる略語

例

直し方

初出のところで括弧に入れて展開してください。「CI（継続的インテグレーション）」のように。読み手が名前として知っている略語（社名など）なら、chaff.yaml の names に並べると求めません。

なぜ指摘するのか

略語は読む人によって指すものが違います。社内で通じても、半年後の自分や別の部署には通じません。

指摘しないもの

誰でも知っている略語（URL、PDF など）と、前後の括弧で説明した略語、会社の名前の中の英字（㈱ADEKA、CO.,LTD.）は指しません。ひな形の名前の置き場所（OOOO、XX 月）と、外のページへのリンクを並べた一覧の題名の中の略語も指しません（題名の略語は数には入れます）。大文字の違うだけの書き方で説明した略語（TCoP と TCOP）、略語を話題にする文で語に書き出した略語（略語の DOB … date of birth）、一覧で語のすぐ下にその語を名指すリンクを入れ子にした語（- GPL の下の GNU General Public License）も指しません。判例の引用の中の当事者と裁判所の名前（Ashwander v. TVA, 297 U.S. 288、MCI Telecomms. Corp. v. AT&T、(SDNY 1952)）、引用の中の行政機関の事件番号（NOV/CFA 01-01）も指しません（引用の略語は数には入れます）。判決の頭の MR. JUSTICE も指しません。括弧の中で略語に「or」で別の呼び名を添えたもの（Department of Health and Human Services (HHS or the Department)）、ハイフンで繋いだ字まで名前と揃うもの（Agency for Health (ARPA-H)）は説明したと読み、メールアドレスの中の英字（OASH-RFI@hhs.gov）は略語と読みません。文書の中に書いた ABNF の文法の規則の名前と値（CRLF、%x0D）、等級の並び（A と AA）、番号で引く官報や判例集（80 FR 66128、2022 WL 4447293）、日付の付いた識別子の前の種類（WD WD-ABC1-20200101）、PO Box の PO も指しません。文献を引いて始まる注（1. See L. Summers (2015), "…," IMF Economic Review）の中の略語は、引いた文献の題名や誌名の書き方なので指しません（数には入れます）。

止める・ゆるめる

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