chaffjs 0.18.0 → 0.20.0

package/rules/unknown-word.yaml

@@ -0,0 +1,62 @@
+id: unknown-word
+layer: L2
+status: experimental
+how_to_find: unknown-word
+languages: [en]
+severity: info
+
+name:
+  ja: 辞書に無い語（綴りの誤りの候補）
+  en: Word not in the dictionary
+
+why:
+  ja: 英語の語のうち辞書に無く、一字違いの辞書の語があるもの（attched と attached）は、打ち間違いのことが多いです。chaff は英語のアダプタが持つ辞書（wink-lexicon と WordNet から作った語の一覧）で語を引き、語尾（-ed、-ing）と接頭辞（un-、re-）を外しても辞書に無い語だけを候補にします。大文字を含む語（固有名詞・略語）、コードと URL の中の語、文書で二度以上使う語（その文書の用語のことが多い）、一字違いの辞書の語が無い語は指しません。チームの言葉は chaff.yaml の names に足すと指さなくなります。
+  en: An English word that is not in the dictionary but is one letter away from a word that is ("attched" and "attached") is usually a typo. chaff looks words up in the English adapter's dictionary (a word list built from wink-lexicon and WordNet), after taking off endings (-ed, -ing) and prefixes (un-, re-). Words with a capital letter (names, acronyms), words in code and URLs, words used twice or more in the document (usually its own terms), and words with no dictionary word one letter away are not reported. Add a team's own words to names in chaff.yaml.
+
+message:
+  ja: 「{word}」は辞書にありません。「{suggestion}」の打ち間違いではありませんか
+  en: '"{word}" is not in the dictionary; did you mean "{suggestion}"?'
+
+how_to_fix:
+  ja: 打ち間違いなら直してください。正しい語なら、chaff.yaml の names に足してください。
+  en: If it is a typo, correct it. If the word is right, add it to names in chaff.yaml.
+
+placeholders:
+  word:
+    ja: 語
+    en: the word
+  suggestion:
+    ja: 辞書の語
+    en: a dictionary word
+
+levels: { strict: warning, normal: info, relaxed: info }
+
+use_for: [business, technical, blog, legal, docs, academic, literature, speech]
+
+group: slips
+summary:
+  en: An English word that is not in the dictionary and is one letter away from one that is, such as "attched"
+  ja: 辞書に無く、一字違いの辞書の語がある英語の語（attched）
+example:
+  en:
+    before: |
+      The report is attched to this email.
+    after: |
+      The report is attached to this email.
+
+not_flagged:
+  ja: 大文字を含む語、四字より短い語、コード・URL・メールアドレスの中の語、文書で二度以上使う語、一字違いの辞書の語が無い語、chaff.yaml の names に並べた語、語彙表 known-misspelling が別に言う語は指しません。
+  en: Words with a capital letter, words shorter than four letters, words in code, URLs and email addresses, words used twice or more in the document, words with no dictionary word one letter away, words listed under names in chaff.yaml, and the misspellings known-misspelling reports are not reported.
+rewrite:
+  en:
+    direction: If the flagged word is a typo, replace it with the suggested dictionary word, or another word the sentence means. If it is a real word or a name, leave it and add it to names in chaff.yaml.
+    pairs:
+      - before: The thresholds were recalibrated and the pipline restarted.
+        after: The thresholds were recalibrated and the pipeline restarted.
+      - before: The report is attched to this email.
+        after: The report is attached to this email.
+    keep:
+      - the wording around the word
+      - names and terms that are spelled that way on purpose
+    avoid:
+      - replacing a correct technical term with the dictionary's nearest word

package/rules/unqualified-superlative.yaml

@@ -26,22 +26,23 @@ how_to_fix:
 levels: { strict: 1, normal: 2, relaxed: 4 }
 
 use_for: [business, blog, legal, docs, academic, literature, speech]
+sources: [femmer-2017]
 
 group: wording
 summary:
-  ja: 「業界最速」「最高の品質」のように、何と比べたのかを書いていない最上級
+  ja: 「最速」「最高の品質」のように、何と比べたのかを書いていない最上級
   en: A superlative such as "the fastest" with nothing to compare it against
 example:
   ja:
-    before: 当社の新製品は業界最速で、最高の品質です。圧倒的な使いやすさです。
+    before: 当社の新製品は最速で、最高の品質です。圧倒的な使いやすさです。
     after: 当社の新製品は、従来品より処理が二割速くなりました。
   en:
     before: Our new product is the fastest on the market, with unmatched quality and unparalleled ease of use.
     after: Our new product processes orders a fifth faster than the previous model.
 
 not_flagged:
-  ja: 「当社比」「〜の中で」のように、比べる相手や範囲が同じ文にあれば指しません。
-  en: A superlative with its comparison or scope in the same sentence ("in our range", "than last year") is not reported.
+  ja: 「当社比」「〜の中で」「〜のほうが」のように、比べる相手や範囲が同じ文にあれば指しません。「SES との最大の違い」のように、最上級のすぐ前に相手があるときも同じです。「国内最大」「業界最速」のように名詞がじかに付いた最上級と、「日本で最も」のように名前と「で」が前にある最上級は、範囲を言っているので指しません。「」や引用符で引いた言葉の中の最上級は、書き手の主張ではないので指しません。
+  en: A superlative with its comparison or scope in the same sentence ("in our range", "than last year", "the fastest in the industry") is not reported, nor is one inside quotation marks, which are someone else's words.
 level_meaning:
   ja: 比べる相手のない最上級が {limit} 箇所あれば指摘
   en: reported once there are {limit} such claims

package/rules/unused-definition.yaml

@@ -0,0 +1,75 @@
+id: unused-definition
+layer: L3
+status: experimental
+how_to_find: unused-definition
+requires: [structure]
+severity: warning
+
+name:
+  ja: 定義したのに使っていない語
+  en: Term defined but never used
+
+why:
+  ja: 定義した語が本文に一度も出てこなければ、その定義は読み手に覚えさせるだけで何も決めていません。多いのは、本文で別の語に言い換えたあと、定義だけが残った場合です。本文のほうが定義と違う語を使っていないかも確かめてください。
+  en: A term defined and then never used makes the reader learn it for nothing. Usually the body was reworded to another word and the definition stayed behind, so check whether the body now uses a different word for the same thing.
+
+message:
+  ja: 「{term}」を定義していますが、本文で使っていません
+  en: '"{term}" is defined but never used'
+
+how_to_fix:
+  ja: 本文で使っていないなら定義を消してください。本文が別の語で同じものを指しているなら、どちらかに揃えます。
+  en: Delete the definition if nothing uses it. If the body calls the same thing by another word, use one of the two throughout.
+
+# chaff explain と規則の一覧には指摘が無いので、{term} をこう読ませる。
+placeholders:
+  term:
+    ja: 〇〇
+    en: the term
+
+levels: { strict: error, normal: warning, relaxed: info }
+
+use_for: [business, technical, blog, legal, docs, academic, literature, speech]
+
+group: structure
+summary:
+  ja: 定義した語が、本文のどこにも出てこない所
+  en: A term the document defines and then never uses
+example:
+  ja:
+    before: |
+      「本サービス」とは、当社が運営する予約のサイトをいう。利用者は、このサイトを無料で使える。
+    after: |
+      「本サービス」とは、当社が運営する予約のサイトをいう。利用者は、本サービスを無料で使える。
+  en:
+    before: |
+      "Service" means the booking website we run. Users may use the website free of charge.
+    after: |
+      "Service" means the booking website we run. Users may use the Service free of charge.
+
+not_flagged:
+  ja: 定義の書き方（「X」とは、以下「X」という）で書いた語だけを見ます。複数形と所有の形（Services、Seller's）は使用に数えます。同じ語の二つ目の定義は duplicate-definition が言います。
+  en: Only terms defined in a recognised form ("X" means, (the "X")) are checked. Plurals and possessives (Services, Seller's) count as uses. A second definition of the same term is duplicate-definition's to report.
+rewrite:
+  ja:
+    direction: 本文で使っていない定義を消してください。本文が同じものを別の語で呼んでいるなら、その語を定義した語に替えます。どちらかは書き手に聞きます。
+    pairs:
+      - before: 「本サービス」とは、当社が運営する予約のサイトをいう。利用者は、このサイトを無料で使える。
+        after: 「本サービス」とは、当社が運営する予約のサイトをいう。利用者は、本サービスを無料で使える。
+      - before: 「登録情報」とは、利用者が登録した氏名と住所をいう。利用者は、氏名と住所をいつでも変えられる。
+        after: 利用者は、登録した氏名と住所をいつでも変えられる。（本文が定義した語をどこでも使わないとき）
+    keep:
+      - 定義の中身
+    avoid:
+      - 定義を残したまま、本文に使い道を作る
+  en:
+    direction: Delete a definition nothing uses. If the body calls the same thing by another word, replace that word with the defined term; ask the writer which.
+    pairs:
+      - before: '"Service" means the booking website we run. Users may use the website free of charge.'
+        after: '"Service" means the booking website we run. Users may use the Service free of charge.'
+      - before: '"Account Data" means the name and address a user registers. Users may change their name and address at any time.'
+        after: Users may change the name and address they registered at any time. (when nothing else uses the term)
+    keep:
+      - what the definition says
+    avoid:
+      - inventing a use for the term to keep the definition

package/rules/use-before-definition.yaml

@@ -0,0 +1,77 @@
+id: use-before-definition
+layer: L3
+status: experimental
+how_to_find: use-before-definition
+requires: [structure]
+severity: warning
+
+name:
+  ja: 定義より前で使っている語
+  en: Term used before it is defined
+
+why:
+  ja: 文の途中で「（以下「甲」という。）」と定義した語を、その定義より前で使うと、読み手は意味の分からない語を先に読むことになります。前で使った箇所は、定義の前に書き足した文であることが多く、定義の位置が古いままです。
+  en: A term defined in passing, as in (the "Seller"), and used before that point makes the reader meet a word whose meaning has not been given yet. The earlier use is usually a sentence added later, in front of a definition that stayed where it was.
+
+message:
+  ja: 「{term}」を、{defined} 行目の定義より前で使っています
+  en: '"{term}" is used here, before it is defined on line {defined}'
+
+how_to_fix:
+  ja: 定義を最初に使う所へ移すか、前の箇所を定義した語を使わない書き方にしてください。
+  en: Move the definition to the first use, or reword the earlier sentence without the defined term.
+
+placeholders:
+  term:
+    ja: 〇〇
+    en: the term
+  defined:
+    ja: 〇
+    en: N
+
+levels: { strict: error, normal: warning, relaxed: info }
+
+use_for: [business, technical, blog, legal, docs, academic, literature, speech]
+
+group: structure
+summary:
+  ja: 文の途中で括弧に入れて定義した語を、その定義より前で使っている所
+  en: A term defined in passing, as in (the "Seller"), that is used before that point
+example:
+  ja:
+    before: |
+      買主は、毎月末日に代金を支払う。株式会社みなと（以下「買主」という。）と株式会社やまと（以下「売主」という。）は、次のとおり契約する。
+    after: |
+      株式会社みなと（以下「買主」という。）と株式会社やまと（以下「売主」という。）は、次のとおり契約する。買主は、毎月末日に代金を支払う。
+  en:
+    before: |
+      The Seller ships within five days. This agreement is between Harbour Ltd (the "Seller") and Hill Ltd (the "Buyer").
+    after: |
+      This agreement is between Harbour Ltd (the "Seller") and Hill Ltd (the "Buyer"). The Seller ships within five days.
+
+not_flagged:
+  ja: 定義の条（「X」とは…をいう）で定義した語は、前で使っても言いません。定義の条は文書の頭にも終わりにも置く書き方があるためです。最初の一か所だけを指します。
+  en: Terms defined in a definitions clause ("X" means ...) are not checked, since a definitions clause may come first or last. Only the first early use is pointed at.
+rewrite:
+  ja:
+    direction: 定義を、その語を最初に使う文へ移してください。移せないなら、前の文を定義した語を使わない書き方にします。
+    pairs:
+      - before: 買主は、毎月末日に代金を支払う。株式会社みなと（以下「買主」という。）と株式会社やまと（以下「売主」という。）は、次のとおり契約する。
+        after: 株式会社みなと（以下「買主」という。）と株式会社やまと（以下「売主」という。）は、次のとおり契約する。買主は、毎月末日に代金を支払う。
+      - before: 本規約の改定は、利用者に通知する。当社は、予約の仕組み（以下「本サービス」という。）を提供する。本サービスは無料である。
+        after: 当社は、予約の仕組み（以下「本サービス」という。）を提供する。本規約の改定は、利用者に通知する。本サービスは無料である。（前の文が「本規約」を使わずに書けないとき）
+    keep:
+      - 定義の中身と、それぞれの文の中身
+    avoid:
+      - 定義を二か所に書く
+  en:
+    direction: Move the definition to the sentence that first uses the term. If it cannot move, reword the earlier sentence without the defined term.
+    pairs:
+      - before: The Seller ships within five days. This agreement is between Harbour Ltd (the "Seller") and Hill Ltd (the "Buyer").
+        after: This agreement is between Harbour Ltd (the "Seller") and Hill Ltd (the "Buyer"). The Seller ships within five days.
+      - before: The Licensee may cancel at any time. Hill Ltd (the "Licensee") licenses the software from us.
+        after: Hill Ltd may cancel at any time. Hill Ltd (the "Licensee") licenses the software from us.
+    keep:
+      - what each sentence says
+    avoid:
+      - defining the term twice

package/rules/vague-figure-reference.yaml

@@ -0,0 +1,66 @@
+id: vague-figure-reference
+layer: L2
+status: experimental
+how_to_find: vague-figure-pointer
+# 置き場所で指す言い方と、その言い方が指す種類（図・表）。図・表に名前を付ける語は dangling-figure-reference と同じ figure-label。
+# 箇条を置き場所で指す言い方は vague-clause-pointer。文書の構造の木に番号付きの条か章があるときだけ見る。
+word_list: vague-figure-pointer
+extra_word_lists: [figure-label, vague-clause-pointer]
+severity: warning
+
+name:
+  ja: 図や表、箇条を「上記の図」のように指している
+  en: A figure, table or clause pointed at by where it is
+
+why:
+  ja: 「上記の図」「下の表」は、どの図のことかを読み手に探させます。図を足したり動かしたりすると、指す先が黙って変わります。印刷やページの区切り、画面の幅で「上」「下」も変わります。JIS Z 8301:2019 の 10.6 は「上記の図」「以下の箇条」のような引用をしないとしています。図や表に番号を付けている文書なら、「図 3」のように番号で指せます。箇条も、条や章に番号を付けている文書なら「箇条 4」のように指せます。番号を一つも付けていない種類は見ません。
+  en: '"The figure above" makes the reader search for the figure. When a figure is added or moved, what it points at changes without a word. Printing, page breaks and the width of the screen change what is above and below as well. JIS Z 8301:2019, 10.6, rules out pointers such as "the figure above". A document that numbers its figures and tables can name them ("Figure 3"), and one that numbers its clauses can name a clause ("Clause 4"). A kind that the document never numbers is not checked.'
+
+message:
+  ja: 「{matched}」ではなく、番号で指してください（この文書は{kind}に番号を付けています）
+  en: 'Name it by its number instead of "{matched}" (this document numbers its {kind}s)'
+
+how_to_fix:
+  ja: 指している図や表、箇条の番号を書いてください。「上記の図のとおり」は「図 3 のとおり」に、「以下の箇条による」は「箇条 5 による」に。
+  en: 'Write the number of the figure, table or clause. "As the figure above shows" becomes "as Figure 3 shows"; "under the clause below" becomes "under Clause 5".'
+
+placeholders:
+  matched:
+    ja: 見つけた言い方
+    en: the phrase found
+  kind:
+    ja: 図、表や箇条
+    en: figure, table or clause
+
+levels: { strict: error, normal: warning, relaxed: info }
+
+use_for: [business, technical, blog, legal, docs, academic, literature, speech]
+sources: [jis-z8301-2019]
+
+group: structure
+summary:
+  ja: 図や表、条に番号を付けた文書で、「上記の図」「下の表」「以下の箇条」のように置き場所で指している所
+  en: '"The figure above", "the table below" or "the clause below" in a document that numbers its figures, tables or clauses'
+example:
+  ja:
+    before: |
+      売上は上記の図のとおり伸びた。
+
+      図1　売上の推移
+    after: |
+      売上は図1のとおり伸びた。
+
+      図1　売上の推移
+  en:
+    before: |
+      Sales rose, as the figure below shows.
+
+      Figure 1: Sales by month
+    after: |
+      Sales rose, as Figure 1 shows.
+
+      Figure 1: Sales by month
+
+not_flagged:
+  ja: 番号を一つも付けていない種類（番号で指しようがない）、番号を添えた言い方（上の図1）、長い語の一部（向上の図、上の図表）、コードの中は見ません。
+  en: 'A kind the document never numbers is not checked: there is no number to use. Nor are "Figure 2 below" (it has the number), a phrase inside a longer word, and code.'

package/rules/vague-link-text.yaml

@@ -0,0 +1,77 @@
+id: vague-link-text
+layer: L1
+status: experimental
+how_to_find: vague-link-text
+word_list: vague-link-text
+requires: [markdown]
+severity: warning
+
+name:
+  ja: 行き先を言わないリンクの言葉
+  en: Link text that does not say where it goes
+
+why:
+  ja: 「[こちら](…)」「[ここをクリック](…)」のように、リンクの言葉がそれだけでは行き先を言わないと、読み手はリンクの前後を読み直して行き先を推し量ることになります。画面読み上げはリンクだけを並べて読み上げるので、「こちら、こちら、こちら」と聞こえ、どれがどこへ行くのか分かりません（WCAG 2.4.4 リンクの目的）。言葉全体が語彙表の語（こちら、ここ、詳細、click here、read more）のときだけを指し、行き先を言っている言葉（「料金表はこちら」）は指しません。
+  en: Link text such as "click here" or "read more" says nothing about where the link goes, so the reader has to reread the sentence around it. A screen reader can list the links on their own, and then hears "here, here, here" with no way to tell them apart (WCAG 2.4.4, link purpose). Only link text that is wholly a word from the lexicon (here, click here, read more, こちら) is reported; text that names the target ("the pricing page") is not.
+
+message:
+  ja: リンクの言葉「{text}」は、行き先を言っていません
+  en: 'The link text "{text}" does not say where it goes'
+
+how_to_fix:
+  ja: 行き先の名前をリンクの言葉にしてください（「料金は[こちら](…)」→「[料金表](…)を見てください」）。
+  en: Make the name of the target the link text ("click [here](…) for pricing" → "see the [pricing page](…)").
+
+placeholders:
+  text:
+    ja: リンクの言葉
+    en: the link text
+
+levels: { strict: error, normal: warning, relaxed: info }
+
+use_for: [business, technical, blog, legal, docs, academic, literature, speech]
+
+group: structure
+summary:
+  ja: 「[こちら](…)」「[ここをクリック](…)」のように、言葉だけでは行き先の分からないリンク
+  en: A link whose whole text is "here", "click here" or "read more"
+example:
+  ja:
+    before: |
+      料金の一覧は[こちら](https://example.com/pricing)です。
+    after: |
+      料金は[料金表](https://example.com/pricing)にあります。
+  en:
+    before: |
+      For prices, click [here](https://example.com/pricing).
+    after: |
+      Prices are on the [pricing page](https://example.com/pricing).
+
+not_flagged:
+  ja: 言葉の一部に「こちら」を含むだけのリンク（「料金表はこちら」）、URL をそのまま書いたリンク、参照の形のリンク（[こちら][1]）は指しません。Markdown でない文書と、引用（>）とコードの中のリンクも見ません。
+  en: Link text that only contains such a word ("pricing here"), a bare or angle-bracket URL, and reference-style links ([here][1]) are not reported, nor are links in a quotation (>), in code, or in a document that is not Markdown.
+rewrite:
+  ja:
+    direction: リンクの言葉を、行き先の名前（ページの題、資料の名前）に変えてください。「こちら」「ここ」は文から外し、文は行き先の名前を言う形に組み直します。行き先の URL は変えません。
+    pairs:
+      - before: 料金の一覧は[こちら](https://example.com/pricing)です。
+        after: 料金は[料金表](https://example.com/pricing)にあります。
+      - before: 申請の手順は[ここをクリック](https://example.com/apply)してください。
+        after: 申請の手順は[申請の手引き](https://example.com/apply)にあります。
+    keep:
+      - リンクの行き先（URL）
+      - 文の言っていること
+    avoid:
+      - 行き先の名前を推し量って、URL の中身と違う名前を付ける
+  en:
+    direction: Make the name of the target (the page title or the document's name) the link text. Drop "here" and "click", and recast the sentence around the name. Keep the URL.
+    pairs:
+      - before: For prices, click [here](https://example.com/pricing).
+        after: Prices are on the [pricing page](https://example.com/pricing).
+      - before: To apply, [read more](https://example.com/apply).
+        after: To apply, follow the [application guide](https://example.com/apply).
+    keep:
+      - the link target (the URL)
+      - what the sentence says
+    avoid:
+      - guessing a name the target page does not have

package/rules/vague-word-density.yaml

@@ -0,0 +1,89 @@
+id: vague-word-density
+layer: L2
+status: experimental
+how_to_find: vague-density
+word_list: vague-word
+uses: [pos]
+severity: info
+
+name:
+  ja: あいまいな語が多い
+  en: Too many vague words
+
+why:
+  ja: 「適宜」「適切に」「必要に応じて」「なるべく」は、どこまで・いつまで・何をしたら済むのかを読み手に決めさせます。一つ二つは普通の言い方ですが、重なると、文書の言っていることの多くを読み手が埋めることになり、人によって読み方が変わります。ISO/IEC/IEEE 29148 が要求の文で避ける語として挙げる言い方と同じ種類です。文書の長さに対して多いときだけ指します。語の一覧は言語ごとの語彙表にあります。
+  en: '"As appropriate", "as needed", "reasonable" and "in a timely manner" leave the reader to decide how far, how soon and what counts as done. One or two are ordinary; many leave much of the document to the reader, and two readers will fill it in differently. ISO/IEC/IEEE 29148 lists the same kind of word among those a requirement avoids. chaff speaks only when they are dense for the document''s length. The words are listed in each language''s lexicon.'
+
+message:
+  ja: 「{matched}」など、あいまいな語が 1000 字あたり {density} 個あります（{limit} 個まで）
+  en: '"{matched}" and other vague words: {density} per 1000 words (limit {limit})'
+
+how_to_fix:
+  ja: 大事なところから、何を・どこまで・いつまでを書いてください。「適宜報告する」は「毎週金曜に報告する」、「必要に応じて」は、どんなときに必要なのかを書きます。
+  en: 'Where it matters, say what, how far and by when: "report as needed" becomes "report every Friday", and "as appropriate" names the case.'
+
+placeholders:
+  matched:
+    ja: 見つけたあいまいな語の一つ
+    en: one of the vague words found
+
+# 日本語は 1000 字、英語は 1000 語あたり。英語の 1000 語は日本語の 1000 字よりずっと長い。
+levels:
+  ja: { strict: 1, normal: 2, relaxed: 4 }
+  en: { strict: 2, normal: 4, relaxed: 8 }
+
+use_for: [business, technical, blog, legal, docs, academic, literature, speech]
+
+group: wording
+summary:
+  ja: 「適宜」「適切に」「必要に応じて」のように、どこまで・いつまでを読み手に決めさせる語が、文書の長さに対して多い所
+  en: Vague words ("as appropriate", "as needed", "in a timely manner"), many for the document's length
+example:
+  ja:
+    pad: true
+    before: |
+      障害が起きたら適宜報告し、必要に応じて関係者に連絡してください。復旧後は適切に記録を残し、なるべく早めに再発防止策をまとめます。
+    after: |
+      障害が起きたら 30 分以内に報告し、影響のある部署に連絡してください。復旧後は障害票に記録を残し、翌営業日までに再発防止策をまとめます。
+  en:
+    pad: true
+    before: |
+      Report incidents as needed and notify the appropriate people in a timely manner. Keep adequate records and fix the cause where possible.
+    after: |
+      Report an incident within 30 minutes and notify the affected teams. Record it in the incident log and fix the cause by the next working day.
+
+not_flagged:
+  ja: 文書の長さに対して少ないものは指しません。短すぎる文書も測りません。要求の文の中の「可能な限り」「必要に応じて」は、要求の書き方として requirement-smell も見ます。
+  en: A few vague words for the document's length are not reported, and very short documents are not measured. Inside a requirement, requirement-smell also reads "where possible" and "as needed".
+level_meaning:
+  ja: 1000 字あたりあいまいな語 {limit} 個まで
+  en: up to {limit} vague words per 1000 words
+rewrite:
+  ja:
+    direction: あいまいな語を、何を・どこまで・いつまでに置き換えてください。決まっていないなら、決まっていないことと、誰が決めるのかを書きます。
+    pairs:
+      - before: 障害が起きたら適宜報告してください。
+        after: 障害が起きたら 30 分以内に報告してください。
+      - before: 必要に応じて関係者に連絡します。
+        after: 顧客に影響があるときは、営業部に連絡します。
+      - before: なるべく早めに対応します。
+        after: 今週中に対応します。
+    keep:
+      - 書き手が約束している範囲（約束していない期限を足さない）
+      - 依頼の相手と中身
+    avoid:
+      - 書き手の知らない数字や期限を作る
+      - あいまいな語を別のあいまいな語（随時、しかるべく）に替える
+  en:
+    direction: Replace each vague word with what, how far or by when. If it is not decided, say so and say who decides.
+    pairs:
+      - before: Report incidents as needed.
+        after: Report every incident within 30 minutes.
+      - before: Notify the appropriate people in a timely manner.
+        after: Notify the on-call engineer within an hour.
+    keep:
+      - what the writer actually commits to (do not invent a deadline)
+      - who is asked and what
+    avoid:
+      - making up numbers or deadlines the writer does not know
+      - swapping one vague word for another ("promptly", "as required")

package/rules/very-adjective.yaml

@@ -0,0 +1,61 @@
+id: very-adjective
+layer: L2
+status: experimental
+how_to_find: intensified-adjective
+word_list: very-intensifier
+extra_word_lists: [very-exception]
+requires: [pos]
+languages: [en]
+severity: info
+
+name:
+  ja: 「very + 形容詞」の多用
+  en: Too many "very" + adjective
+
+why:
+  ja: 英語の「very important」「very good」は、強い一語（critical、excellent）か、何がどうなのかを言えば要らない語です。一つ二つなら普通ですが、文書の長さのわりに多いと、どの「very」も効かなくなります。「the very first」「very few」のように意味の決まった言い方は語彙表で除いています。
+  en: '"Very important" and "very good" lean on "very" where a stronger word (critical, excellent), or saying what and how much, would do. One or two are ordinary; many for the length make every "very" weightless. Set phrases such as "the very first" and "very few" are excepted in the lexicon.'
+
+message:
+  ja: 「{matched}」など、very + 形容詞が 1000 語あたり {density} 個あります（{limit} 個まで）
+  en: '"{matched}" and other "very" + adjective: {density} per 1000 words (limit {limit})'
+
+how_to_fix:
+  ja: 強い一語に替えるか、何がどの程度なのかを書いてください（very important → critical、very fast → under a second）。
+  en: Use a stronger word, or say what and how much ("very important" → "critical", "very fast" → "under a second").
+
+levels: { strict: 1, normal: 2, relaxed: 4 }
+
+use_for: [business, technical, blog, legal, docs, academic, literature, speech]
+
+group: wording
+summary:
+  ja: 英語で、「very important」「very good」のような very + 形容詞が、文書の長さのわりに多い所
+  en: '"Very" + adjective, such as "very important", dense for the document''s length'
+example:
+  en:
+    pad: true
+    before: |
+      The launch was very important. The team was very busy, and the plan was very good.
+    after: |
+      The launch was critical. The team was stretched, and the plan held.
+
+not_flagged:
+  ja: 「very」の後ろが形容詞のときだけ数えます（very well は数えない）。「the very first」「very few」「very much」は数えません。短い文書は密度を測りません。小説と話し言葉では既定で止めています（会話の言葉のため）。
+  en: Only "very" before an adjective ("very well" is not counted), and not "the very first", "very few" or "very much". Short documents are not measured. The fiction and speech presets turn it off, since dialogue speaks that way.
+level_meaning:
+  ja: very + 形容詞が 1000 語あたり {limit} 個まで
+  en: up to {limit} "very" + adjective per 1000 words
+rewrite:
+  en:
+    direction: Replace "very" + adjective with a stronger single word, or with what the text says about how much. If the text says nothing more, a plain adjective without "very" will do.
+    pairs:
+      - before: The launch was very important.
+        after: The launch was critical.
+      - before: The new build is very fast.
+        after: The new build starts in under a second.
+    keep:
+      - the claim each sentence makes
+    avoid:
+      - swapping "very" for another intensifier ("really", "extremely")
+      - inventing figures the text does not give

package/rules/weasel-word.yaml

@@ -0,0 +1,60 @@
+id: weasel-word
+layer: L2
+status: experimental
+how_to_find: phrase-match
+word_list: weasel-word
+requires: [pos]
+languages: [en]
+severity: info
+
+name:
+  ja: 出所を言わない「多くの専門家」
+  en: Weasel words
+
+why:
+  ja: 英語の「many experts say」「it is widely believed」「studies show」は、主張を名前の無い大勢や、どれとも言わない研究に預けます。読み手は誰がそう言ったのかを確かめられず、書き手は主張に責任を持たずに済みます。言い回しは言語ごとの語彙表にあります。
+  en: '"Many experts say", "it is widely believed" and "studies show" lend a claim to an unnamed crowd or to research no one names. The reader cannot check who said it, and the writer need not stand behind it. The phrases are listed in the lexicon.'
+
+message:
+  ja: 「{matched}」は、誰が言ったのかを言っていません
+  en: '"{matched}" does not say who'
+
+how_to_fix:
+  ja: 誰が・どの研究がそう言ったのかを書いてください（名前、年、出典）。書けないなら、書き手自身の主張として書くか、その文を落としてください。
+  en: Name who said it or which study shows it (a name, a year, a source). If you cannot, state it as your own claim, or drop it.
+
+levels: { strict: 1, normal: 1, relaxed: 2 }
+
+use_for: [business, technical, blog, legal, docs, academic, literature, speech]
+
+group: wording
+summary:
+  ja: 英語で、「many experts say」「studies show」のように、主張を名前の無い誰かに預ける言い回し
+  en: Phrases such as "many experts say" and "studies show" that credit a claim to no one in particular
+example:
+  en:
+    before: |
+      Many experts say remote work raises output.
+    after: |
+      A 2023 Stanford study of 1,600 staff found remote work raised output by 4%.
+
+not_flagged:
+  ja: 一覧にある言い回しだけを見ます。英語の文書だけで動きます。すぐ後ろに出典が書いてあっても指摘します（文の中で研究の名前を言えるため）。
+  en: Only the phrases on chaff's list are checked, and only in English documents. A citation right after the phrase does not silence it, since the sentence can name the study itself.
+level_meaning:
+  ja: 当てはまる言い回しが {limit} 箇所あれば指摘
+  en: reported once there are {limit}
+rewrite:
+  en:
+    direction: Replace the unnamed crowd ("many experts", "studies") with the person or study the text or its sources name. If they name none, do not invent one; ask the writer, or state the claim as the writer's own.
+    pairs:
+      - before: Studies show that short meetings save time [3].
+        after: Smith (2021) found that 15-minute meetings saved each team two hours a week [3].
+      - before: It is widely believed that the old API is slower.
+        after: Our load test in May found the old API 30% slower.
+    keep:
+      - the citation number or link
+      - the claim itself
+    avoid:
+      - inventing a study or a name the text does not give
+      - swapping one unnamed crowd for another ("some researchers")