chaffjs 0.18.0 → 0.20.0

package/rules/requirement-modal.yaml

@@ -0,0 +1,94 @@
+id: requirement-modal
+layer: L2
+status: experimental
+how_to_find: requirement-modal
+# 何を見るかは options で決める。決めなければ何も見ない。語は言語ごとの語彙表 requirement-modal-<standard> と requirement-modal-must にある。
+uses: [pos]
+severity: warning
+
+name:
+  ja: 規定の文末が、決めた書き方と違う
+  en: A provision's verb form is not the one the house rule uses
+
+why:
+  ja: 規格や規程は、要求・推奨・許容を文末の形で書き分けます。読み手は文末で、守らなければならないのか、望ましいだけなのか、してもよいのかを読み取ります。JIS Z 8301:2019 は、推奨に「…すべきである」を、許容と可能性に文末の「…できる」を使わないと決め、「…することが望ましい」「…してもよい」「…可能である」を使います。英語では、米国連邦政府の Plain Language Guidelines が、義務には曖昧な "shall" ではなく "must" を使うとしています。どちらもチームが選ぶ決まりなので、options で決めたときだけ見ます。
+  en: 'A standard or a set of rules tells a requirement from a recommendation and a permission by the form of the verb, and the reader takes from it whether something must be done, should be done or may be done. JIS Z 8301:2019 does not use 「…すべきである」 for a recommendation or a closing 「…できる」 for a permission or a possibility; it uses 「…することが望ましい」, 「…してもよい」 and 「…可能である」. In English, the Federal Plain Language Guidelines use "must" for an obligation instead of "shall", which readers and courts take in more than one way. Both are a team''s choice, so the rule checks only what options turn on.'
+
+message:
+  ja: 「{matched}」は使わない形です。「{preferred}」と書きます
+  en: 'Write "{preferred}" instead of "{matched}"'
+
+how_to_fix:
+  ja: 文が言っていることが要求・推奨・許容・可能性のどれかを決めて、その形に直してください。推奨なら「…することが望ましい」、許容なら「…してもよい」、可能性なら「…可能である」「…場合がある」です。
+  en: 'Decide whether the sentence states an obligation and write "must" ("must not" for a prohibition). Keep "shall" only where a law you quote uses it.'
+
+placeholders:
+  matched:
+    ja: 見つけた形
+    en: the form found
+  preferred:
+    ja: 使う形
+    en: the form to use
+
+levels: { strict: error, normal: warning, relaxed: info }
+
+options:
+  standard:
+    kind: choice
+    default: none
+    about:
+      ja: 規定の文末を、どの規格の決まりで見るか（日本語）
+      en: Which standard's verbal forms a Japanese provision is checked against
+    choices:
+      none:
+        ja: 見ない
+        en: Not checked
+      jis-z8301-2019:
+        ja: JIS Z 8301:2019 の 7.3〜7.5。文末の「すべきである」「すべきでない」「できる」「できない」を指す
+        en: "JIS Z 8301:2019, 7.3 to 7.5: a closing すべきである, すべきでない, できる or できない"
+  shall:
+    kind: choice
+    default: allow
+    about:
+      ja: 英語の "shall" を見るか
+      en: Whether "shall" is checked in English
+    choices:
+      allow:
+        ja: 見ない
+        en: Not checked
+      must:
+        ja: '"shall" を指し、"must" と書かせる（Federal Plain Language Guidelines）'
+        en: 'Point at "shall" and ask for "must" (Federal Plain Language Guidelines)'
+
+use_for: [business, technical, blog, legal, docs, academic, literature, speech]
+sources: [jis-z8301-2019, plain-2011]
+
+group: team
+summary:
+  ja: 規格・規程の文末が、チームの選んだ決まり（JIS Z 8301:2019 など）と違う所。options で決めたときだけ見ます
+  en: A provision's verb form that the house rule the team picked does not use ("shall" under the Federal Plain Language Guidelines); checked only when options pick one
+example:
+  ja:
+    before: |
+      試験の前に、試料を乾燥させるべきである。
+    after: |
+      試験の前に、試料を乾燥させることが望ましい。
+    config:
+      genre: technical/spec
+      options:
+        requirement-modal:
+          standard: jis-z8301-2019
+  en:
+    before: |
+      The supplier shall deliver the goods within 30 days.
+    after: |
+      The supplier must deliver the goods within 30 days.
+    config:
+      genre: technical/spec
+      options:
+        requirement-modal:
+          shall: must
+
+not_flagged:
+  ja: options で決めなければ何も見ません。「できる」は文の終わりだけを見ます（JIS は能力を示す「できる」を文の途中で使うのを認めています）。
+  en: Nothing is checked until options pick a standard. In Japanese, できる is checked only at the end of a sentence, since JIS allows it mid-sentence for an ability.

package/rules/requirement-smell.yaml

@@ -0,0 +1,70 @@
+id: requirement-smell
+layer: L2
+status: experimental
+how_to_find: requirement-smell
+# 要求の文の目印と、三つの見つけ方の語。語はすべて言語ごとの語彙表にある。
+word_list: requirement-marker
+extra_word_lists: [requirement-loophole, requirement-open-end, requirement-either]
+uses: [pos]
+severity: warning
+
+name:
+  ja: 要求の文に、決めきれない言い方がある
+  en: A requirement that leaves its reader to decide
+
+why:
+  ja: 仕様書や契約書の要求は、満たしたかどうかを誰が読んでも同じに決められる必要があります。「可能な限り」「必要に応じて」は、どこまでしたら満たしたことになるのかを書き手が決めずに残します。要求の文の「等」「など」は、ほかに何が含まれるのかを残し、「及び／又は」は両方なのか片方でよいのかを残します。要求の書き方を調べた研究（Femmer ほか 2017、Berry ほか 2003）と ISO/IEC/IEEE 29148 が、どれも避ける言い方に挙げています。要求の文（「〜しなければならない」「〜ものとする」「〜こと。」で終わる文）だけを見ます。
+  en: 'A requirement in a specification or a contract must be one that any reader can check the same way. "As far as possible" and "if necessary" leave open how much is enough. "Etc." in a requirement leaves open what else it covers, and "and/or" leaves open whether both are meant or one is enough. Studies of requirements (Femmer et al. 2017; Berry et al. 2003) and ISO/IEC/IEEE 29148 all list these among the phrases to avoid. Only a sentence that states a requirement (with shall, must or is required to) is checked.'
+
+message:
+  ja: 「{matched}」は、要求を決めきらずに残しています
+  en: '"{matched}" leaves the requirement open'
+
+messages:
+  loophole:
+    ja: 「{matched}」は、どこまでしたら満たしたことになるのかを決めていません
+    en: '"{matched}" does not say how much is enough to meet the requirement'
+  open-end:
+    ja: 要求の中の「{matched}」は、ほかに何が含まれるのかを決めていません
+    en: '"{matched}" in a requirement does not say what else it covers'
+  either:
+    ja: 「{matched}」は、両方なのか片方でよいのかを決めていません
+    en: '"{matched}" does not say whether both are meant or either is enough'
+
+how_to_fix:
+  ja: 満たしたかどうかを確かめられる形に書き直してください。「可能な限り速く」なら「3 秒以内に」、「ログ等を保存すること」なら保存するものを全部並べる、「A 及び／又は B」なら「A 又は B（両方でもよい）」のように。
+  en: 'Rewrite it so that meeting it can be checked: "as fast as possible" becomes "within 3 seconds", "logs, etc." becomes the full list, and "A and/or B" becomes "A, B, or both".'
+
+placeholders:
+  matched:
+    ja: 見つけた語
+    en: the phrase found
+
+levels: { strict: error, normal: warning, relaxed: info }
+
+# 要求を書く文書だけ。仕様書、契約書・規約、説明書（マニュアル・FAQ）。ほかの法務・説明書のジャンルと、学術・文学・話し言葉は
+# genres.yaml で止める（法令は「等」を定義して使う、用語集の「〜すること。」は語の説明）。
+use_for: [technical/spec, legal, docs, academic, literature, speech]
+sources: [femmer-2017, berry-2003, iso-29148]
+
+group: wording
+summary:
+  ja: 仕様書や契約書の要求の文にある「可能な限り」「必要に応じて」「等」「及び／又は」
+  en: '"As far as possible", "if necessary", "etc." or "and/or" in a requirement of a specification or a contract'
+example:
+  ja:
+    before: |
+      予約の画面は、可能な限り速く表示されなければならない。
+    after: |
+      予約の画面は、3 秒以内に表示されなければならない。
+    config: { genre: technical/spec }
+  en:
+    before: |
+      The booking page must load as fast as possible.
+    after: |
+      The booking page must load within 3 seconds.
+    config: { genre: technical/spec }
+
+not_flagged:
+  ja: 要求の文でない文（説明や背景）、法令、ブログやビジネス文書は見ません。語彙表にない言い方は指しません。
+  en: Sentences that state no requirement (background, explanation), statutes, and blogs and business documents are not checked. Phrases not on chaff's lists are not reported.

package/rules/rule-of-three.yaml

@@ -22,7 +22,8 @@ how_to_fix:
 
 levels: { strict: 50, normal: 70, relaxed: 90 }
 
-use_for: [blog, legal, docs, academic, literature, speech]
+use_for: [technical/readme, blog, legal, docs, academic, literature, speech]
+sources: [reinhart-2025, zhang-2024]
 
 group: ai-tells
 summary:
@@ -115,8 +116,53 @@ example:
       - No review
 
 not_flagged:
-  ja: 箇条書きが 3 つより少ない文書は見ません。ビジネス文書と技術文書のジャンルでは見ません。
-  en: Documents with fewer than three lists are not checked. Business and technical genres do not run this rule.
+  ja: 箇条書きが 3 つより少ない文書は見ません。ビジネス文書と仕様書（technical/spec）のジャンルでは見ません。
+  en: Documents with fewer than three lists are not checked. Business and specification (technical/spec) genres do not run this rule.
 level_meaning:
   ja: 3 項目の箇条書きの割合 {limit}% まで
   en: up to {limit}% of lists with exactly three items
+rewrite:
+  ja:
+    direction: 三つ並んだ箇条書きのうち、ほかの項目と同じことを言っている項目を消すか、一つにまとめてください。本当に三つあるリストはそのままにします。
+    pairs:
+      - before: |
+          - 速い
+          - 高速に動く
+          - 安い
+        after: |
+          - 速い
+          - 安い
+      - before: |
+          - 費用の削減
+          - コストの低減
+          - 保守の手間が減る
+        after: |
+          - 費用が下がる
+          - 保守の手間が減る
+    keep:
+      - 互いに別のことを言っている項目
+    avoid:
+      - 別々のことを一つにまとめて意味を変える
+      - 三つを避けるために四つ目を作る
+  en:
+    direction: In each list of three, delete or merge the item that says what another item already says. A list that really has three items stays.
+    pairs:
+      - before: |
+          - fast
+          - quick to run
+          - cheap
+        after: |
+          - fast
+          - cheap
+      - before: |
+          - lower costs
+          - reduced spending
+          - less maintenance
+        after: |
+          - lower costs
+          - less maintenance
+    keep:
+      - items that say different things
+    avoid:
+      - merging two different things into one and changing the meaning
+      - inventing a fourth item to get away from three

package/rules/section-length-uniformity.yaml

@@ -22,7 +22,15 @@ how_to_fix:
 
 levels: { strict: 45, normal: 35, relaxed: 25 }
 
-use_for: [blog, legal, docs, academic, literature, speech]
+options:
+  min_sections:
+    kind: count
+    default: 5
+    about:
+      ja: 測る節の数の下限。節が少ないと長さのばらつきは偶然で小さく出て、人の書いた文書でも揃って見えます
+      en: The fewest sections measured. With few sections, the variation is small by chance, and a person's writing looks uniform too
+
+use_for: [technical/readme, blog, legal, docs, academic, literature, speech]
 
 group: ai-tells
 summary:
@@ -49,6 +57,10 @@ example:
       ## 確かめる
 
       試しの文書を置いて、指摘が画面に出るかを見ます。
+
+      ## 更新する
+
+      新しい版が出たら、同じ公式のページから入れ直します。
     after: |
       # 新しい道具の紹介
 
@@ -67,6 +79,10 @@ example:
       ## 確かめる
 
       試しの文書を置いて、指摘が画面に出るかを見ます。
+
+      ## 更新する
+
+      新しい版は同じページにあります。
   en:
     config: { genre: blog/tech }
     before: |
@@ -87,6 +103,10 @@ example:
       ## Check
 
       Add a sample document and look for findings on the screen.
+
+      ## Update
+
+      When a new version comes out, install it again from the same page.
     after: |
       # Introducing the new tool
 
@@ -106,9 +126,13 @@ example:
 
       Add a sample document and look for findings on the screen.
 
+      ## Update
+
+      New versions are on the same page.
+
 not_flagged:
-  ja: ビジネス文書と技術文書のジャンルでは見ません。
-  en: Business and technical genres do not run this rule.
+  ja: 中身のある節が 5 より少ない文書は見ません（min_sections で変えられます）。ビジネス文書と仕様書（technical/spec）のジャンルでは見ません。
+  en: Documents with fewer than 5 sections are not checked (min_sections changes it). Business and specification (technical/spec) genres do not run this rule.
 level_meaning:
   ja: 節の長さのばらつきが {limit}% 未満なら指摘
   en: reported when section length varies by less than {limit}%

package/rules/sentence-initial-so.yaml

@@ -0,0 +1,58 @@
+id: sentence-initial-so
+layer: L2
+status: experimental
+how_to_find: opener-pile
+word_list: so-opener
+requires: [pos]
+languages: [en]
+severity: info
+
+name:
+  ja: 文頭の「So,」
+  en: Sentence opening with "So,"
+
+why:
+  ja: 英語で文の頭に置く「So,」は、話し言葉の間合いを書き言葉に持ち込んだものです。前の文との関係（理由・結果・話題の切り替え）を言わずに文をつなぎます。読点の無い「So far」「So that」は普通の書き出しなので数えません。
+  en: '"So," at the head of a sentence carries a spoken pause into writing. It joins the sentence to the last without saying how (a reason, a result, a change of topic). "So far" and "So that", without the comma, open a sentence on their own terms and are not counted.'
+
+message:
+  ja: 「{matched}」で始まる文が {count} 個あります（{limit} 個から）
+  en: '{count} {count|sentence opens|sentences open} with "{matched}" ({limit} needed)'
+
+how_to_fix:
+  ja: 「So,」を消して読み直してください。つながりが要るなら、それを言う語（Therefore、As a result）に替えます。
+  en: Delete "So," and reread. If the link is needed, use a word that says what it is ("Therefore", "As a result").
+
+levels: { strict: 1, normal: 1, relaxed: 3 }
+
+use_for: [business, technical, blog, legal, docs, academic, literature, speech]
+
+group: wording
+summary:
+  ja: 英語で、「So,」で始まる文（話し言葉の間合い）
+  en: A sentence that opens with "So,", a spoken pause carried into writing
+example:
+  en:
+    before: |
+      So, the release moves to Friday.
+    after: |
+      The release moves to Friday.
+
+not_flagged:
+  ja: 読点の付いた「So,」だけを見ます。「So far」「So that」「So the board decided」は数えません。英語の文書だけで動きます。小説と話し言葉では既定で止めています（話す調子がその文書の書き方のため）。
+  en: Only "So," with its comma. "So far", "So that" and "So the board decided" are not counted. Only in English documents; the fiction and speech presets turn it off, since a spoken tone is their form.
+level_meaning:
+  ja: 「So,」で始まる文が {limit} 個あれば指摘
+  en: reported once {limit} sentences open with "So,"
+rewrite:
+  en:
+    direction: Delete the "So," at the head of the sentence. If the link to the last sentence is needed, use a word that says what it is.
+    pairs:
+      - before: So, we moved the release to Friday.
+        after: We moved the release to Friday.
+      - before: The vendor was late. So, the launch slipped.
+        after: The vendor was late. As a result, the launch slipped.
+    keep:
+      - the rest of the sentence
+    avoid:
+      - swapping "So," for another empty opener ("Well,", "Now,")

package/rules/sentence-rhythm.yaml

@@ -27,7 +27,8 @@ levels:
   normal: 30
   relaxed: 20
 
-use_for: [blog, legal, docs, academic, literature, speech]
+use_for: [technical/readme, blog, legal, docs, academic, literature, speech]
+sources: [iwamoto-2026]
 
 group: readability
 summary:
@@ -53,3 +54,28 @@ not_flagged:
 level_meaning:
   ja: 文の長さのばらつきが {limit}% 未満なら指摘
   en: reported when sentence length varies by less than {limit}%
+rewrite:
+  ja:
+    direction: 長めの文のいくつかを、意味の切れ目で二つに割ってください。結論の文は短くします。言葉は足しません。
+    pairs:
+      - before: 設定は管理画面から変えられ、変えた内容はすぐに反映され、元に戻すこともできます。
+        after: 設定は管理画面から変えられ、すぐに反映されます。元にも戻せます。
+      - before: この方式は導入が簡単で費用も安いため、多くの部署で採用されています。
+        after: この方式は導入が簡単で、費用も安い方式です。多くの部署が採用しています。
+    keep:
+      - 文の中身と順番
+    avoid:
+      - 全部の文を短くして、別の単調さにする
+      - リズムのために言葉や例を足す
+  en:
+    direction: Split a few of the longer sentences at a break in the meaning. Make the sentence that carries the conclusion short. Add no words.
+    pairs:
+      - before: The setting can be changed from the admin page, the change applies at once, and it can be undone.
+        after: The setting can be changed from the admin page and applies at once. It can be undone.
+      - before: This method is easy to set up and cheap to run, which is why many departments have adopted it.
+        after: This method is easy to set up and cheap to run. Many departments have adopted it.
+    keep:
+      - what the sentences say, in the same order
+    avoid:
+      - cutting every sentence short, which is another monotone
+      - adding words or examples for the sake of rhythm

package/rules/space-before-punctuation.yaml

@@ -0,0 +1,41 @@
+id: space-before-punctuation
+layer: L1
+status: experimental
+how_to_find: space-before-punctuation
+languages: [en]
+severity: warning
+
+name:
+  ja: 句読点の前に空白がある
+  en: Space before punctuation
+
+why:
+  ja: '英文では句読点を前の語に付けて書きます。「word .」「(word) ,」のように前に空白があると、行の折り返しで句読点だけが次の行の頭に落ちることがあり、書き換えの途中で残った空白に見えます。ピリオド・カンマ・セミコロン・疑問符・感嘆符を見ます。コロン（"Note : "）、空白で区切った省略の点や目次の点線（". . ."）、".NET" や ".5" のように次の語の頭の点、数の後ろ（式の "[ 1 , N ]"）、コードと URL は数えません。前の空白が二つ以上の所（表のように並べた行）も数えません。'
+  en: 'English attaches punctuation to the word before it. A space before it ("word .", "(word) ,") can leave the mark alone at the start of the next line, and reads as a space left over from an edit. Periods, commas, semicolons, question marks and exclamation marks are checked. A colon ("Note : "), dots spaced out as an ellipsis or a leader in a table of contents (". . ."), a dot that starts the next word (".NET", ".5"), a mark after a number ("[ 1 , N ]" in a formula), code and URLs are not counted, nor are two or more spaces before the mark (a line laid out like a table).'
+
+message:
+  ja: 「{mark}」の前に空白があります
+  en: 'A space before "{mark}"'
+
+how_to_fix:
+  ja: 空白を消して、句読点を前の語に付けてください。
+  en: Delete the space and attach the mark to the word before it.
+
+levels: { strict: error, normal: warning, relaxed: info }
+
+use_for: [business, technical, blog, legal, docs, academic, literature, speech]
+
+group: slips
+summary:
+  ja: 英文の「word .」「word ,」のように、句読点の前に空白がある所
+  en: A space before a period, comma, semicolon, question mark or exclamation mark, as in "word ."
+example:
+  en:
+    before: |
+      The form is ready , and the office has a copy .
+    after: |
+      The form is ready, and the office has a copy.
+
+not_flagged:
+  ja: コロン、空白で区切った省略の点や目次の点線（「. . .」）、「.NET」「.5」のような語の頭の点、数の後ろの句読点、二つ以上の空白の後ろの句読点、コードと URL は指しません。
+  en: Colons, dots spaced out as an ellipsis or a leader (". . ."), a dot that starts a word (".NET", ".5"), a mark after a number or after two or more spaces, code and URLs are not reported.

package/rules/spelling-consistency.yaml

@@ -0,0 +1,47 @@
+id: spelling-consistency
+layer: L3
+status: experimental
+how_to_find: spelling-variety
+word_list: spelling-variant
+extra_word_lists: [spelling-ize]
+languages: [en]
+severity: info
+
+name:
+  ja: イギリスとアメリカの綴りが混ざっている
+  en: British and American spellings are mixed
+
+why:
+  ja: colour と color、centre と center、organise と organize のように、イギリスとアメリカの綴りはどちらも正しい英語です。困るのは一つの文書の中で混ざることで、検索で別の語になり、別の人が書いた段落がそこだけ違って見えます。chaff はどちらが正しいかを決めず、文書の中で少ないほうを指摘します。-ise と -ize は別に比べます（Oxford の綴りは colour と organize を一緒に使うため）。文の頭でないのに大文字で始まる語（Labor Day、World Health Organization）は名前なので数えず、引用符の中と引用符で引いた語（‘organize’）も数えません。古い文学の綴りは時代のものなので、文学のジャンルでは既定で止めています。少ないほうが三分の一を超える文書は、使い分けている（引用や固有の用語）と見て言いません。
+  en: British and American spellings (colour and color, centre and center, organise and organize) are both correct English. What reads badly is mixing them in one document, which makes search treat them as different words and makes another writer's paragraph stand out. chaff does not decide which is right; it points at whichever the document uses less. -ise and -ize are compared on their own, since Oxford spelling writes colour with organize. A word capitalised in the middle of a sentence (Labor Day, World Health Organization) is a name and is not counted, nor is anything in quotation marks or a word quoted on its own (‘organize’). The literature preset turns it off, since old spelling belongs to its time. It says nothing when the minority is more than a third, since the document then mixes them on purpose (quotations, fixed terms).
+
+message:
+  ja: 「{matched}」と書いています（この文書はふつう「{other}」の綴り。{of} 箇所のうち {count} 箇所が違う）
+  en: '"{matched}" here, where the document usually spells it "{other}" ({count} of {of})'
+
+how_to_fix:
+  ja: 文書の多いほうの綴りに合わせてください。チームで決めているなら、STYLE.md に書いておくと迷いません。
+  en: Match the spelling the rest of the document uses. If the team has decided, write it in the style guide.
+
+# 少ないほうが組の何パーセントまでなら「混ざっている」と見るか。これを超えたら、文書が使い分けている。
+levels: { strict: 49, normal: 34, relaxed: 20 }
+
+use_for: [business, technical, blog, legal, docs, academic, literature, speech]
+
+group: consistency
+summary:
+  ja: 英語で、colour と color のように、イギリスとアメリカの綴りが一つの文書の中で混ざっている所
+  en: British and American spellings (colour and color, centre and center) mixed in one document
+example:
+  en:
+    before: |
+      The colour of the logo is blue. The colour of the button is green. The color of the link is red.
+    after: |
+      The colour of the logo is blue. The colour of the button is green. The colour of the link is red.
+
+not_flagged:
+  ja: どちらの綴りが正しいかは決めません。-ise と -ize は別に比べるので、Oxford の綴り（colour と organize）はそろっていると見ます。文の途中で大文字で始まる名前（Labor Day）と引用符の中は数えません。
+  en: Neither spelling is called right. -ise and -ize are compared on their own, so Oxford spelling (colour with organize) is consistent. Names capitalised mid-sentence (Labor Day) and quotations are not counted.
+level_meaning:
+  ja: 少ないほうが組の {limit}% 以下のとき指摘
+  en: reported when the minority spelling is {limit}% of its group or less

package/rules/stock-transition.yaml

@@ -27,7 +27,7 @@ levels:
   ja: { strict: 2, normal: 3, relaxed: 5 }
   en: { strict: 4, normal: 6, relaxed: 10 }
 
-use_for: [blog, business, legal, docs, academic, literature, speech]
+use_for: [technical/readme, blog, business, legal, docs, academic, literature, speech]
 
 group: ai-tells
 summary:
@@ -51,5 +51,36 @@ not_flagged:
   ja: 話を運ぶ接続詞（「また」「そのため」「しかし」）と、文の途中の接ぎは数えません。短い文書は測りません。
   en: Words that carry the argument (However, Therefore), a transition inside a sentence, and "In addition to …" are not counted. Short documents are not measured.
 level_meaning:
-  ja: 1000 字あたり {limit} 個まで
-  en: up to {limit} per 1000 words
+  ja: 決まった接ぎで始まる文が 1000 字あたり {limit} 個まで
+  en: up to {limit} sentences per 1000 words opening with a stock transition
+rewrite:
+  ja:
+    direction: 文頭の接ぎの語を消して読み返してください。繋がりが分からなくなる所だけ、前の文との関係（理由、例外、順番）を言葉で書きます。
+    pairs:
+      - before: さらに、ログの保存期間も延ばしました。
+        after: ログの保存期間も延ばしました。
+      - before: 費用が下がりました。加えて、速度も上がりました。
+        after: 費用が下がり、速度も上がりました。
+      - before: このように、設定は三か所で変わります。
+        after: 設定が変わるのは、この三か所です。
+    keep:
+      - 文の順番
+      - 書き手が書いた理由や対比
+    avoid:
+      - 「さらに」を「また」「そして」に替えるだけで済ませる
+      - 書き手が書いていない因果（「〜なので」）を作る
+  en:
+    direction: Delete the transition at the start of the sentence and reread. Only where the link is lost, say what it is (a reason, an exception, an order).
+    pairs:
+      - before: Moreover, we extended log retention.
+        after: We also extended log retention.
+      - before: Costs fell. Additionally, speed improved.
+        after: Costs fell and speed improved.
+      - before: In conclusion, the settings change in three places.
+        after: The settings change in three places.
+    keep:
+      - the order of the sentences
+      - a reason or contrast the writer stated
+    avoid:
+      - swapping "Moreover" for "Also" at the start of every sentence
+      - inventing a cause ("because") the writer did not state

package/rules/summary-fact-mismatch.yaml

@@ -0,0 +1,122 @@
+id: summary-fact-mismatch
+layer: L3
+status: experimental
+how_to_find: summary-fact-mismatch
+requires: [quantities]
+uses: [pos]
+severity: warning
+
+name:
+  ja: 冒頭や要約の値が本文と違う
+  en: A summary value that differs from the body
+
+why:
+  ja: 冒頭や「概要」の節は、本文を読まない人も読みます。そこに書いた値が本文と違うと、要約だけを読んだ人が間違った値を持ち帰ります。本文を直したあとに、要約を直し忘れると起きます。最初の見出しより前の文と、概要・要約・まとめの節の「項目：値」「項目は値です」を、本文の同じ項目の値と比べます。本文の値が一通りに揃っていて、要約の値がそれと違うときだけ指します。
+  en: 'The opening and the summary are read by people who never read the body. A value there that differs from the body sends them away with the wrong one. It happens when the body is corrected and the summary is not. Values written as "Item: value" or "The item is value" before the first heading, or in a section headed Summary, Abstract or Overview, are compared with the body''s values for the same item; it is pointed out only when the body gives one value throughout and the summary gives another.'
+
+message:
+  ja: 冒頭・要約の「{label}」 {value} が、本文の {other} と違います
+  en: 'The summary gives "{label}" as {value}, but the body gives {other}'
+
+how_to_fix:
+  ja: 本文と要約のどちらが正しいかを確かめて、もう一方を直してください。
+  en: Check which is right, the summary or the body, and correct the other.
+
+levels: { normal: warning, relaxed: info }
+
+use_for: [business, technical, blog, legal, docs, academic, literature, speech]
+
+group: facts
+summary:
+  ja: 冒頭や概要の節に書いた値（締切、料金など）が、本文の同じ項目の値と違う所
+  en: A value in the opening or the summary (a deadline, a fee) that differs from the same item in the body
+example:
+  ja:
+    before: |
+      # 説明会
+
+      参加費は3,000円です。
+
+      ## 申し込み
+
+      参加費は3,500円です。
+    after: |
+      # 説明会
+
+      参加費は3,500円です。
+
+      ## 申し込み
+
+      参加費は3,500円です。
+  en:
+    before: |
+      # Workshop
+
+      The fee is $300.
+
+      ## Registration
+
+      The fee is $350.
+    after: |
+      # Workshop
+
+      The fee is $350.
+
+      ## Registration
+
+      The fee is $350.
+
+not_flagged:
+  ja: 本文に同じ項目の値が二通り以上あるとき（回ごと、対象ごとの値）は、要約がどれと合うべきか決まらないので言いません。単位の違う値、条件の付いた値（「3,000円から」）も比べません。
+  en: When the body gives the item more than one value (per session, per group), which one the summary should match is not settled, so nothing is said. Values in different units and values with a condition ("from $300") are not compared.
+rewrite:
+  ja:
+    direction: 要約と本文のどちらの値が正しいかを書き手に確かめ、もう一方を直してください。要約の値を本文から写すときは、単位と条件も一緒に写します。
+    pairs:
+      - before: |
+          概要：締切は10月5日です。
+          （本文）締切は10月7日です。
+        after: |
+          概要：締切は10月7日です。
+          （本文）締切は10月7日です。
+      - before: |
+          ## 概要
+          定員：30名
+          ## 詳細
+          定員：40名
+        after: |
+          ## 概要
+          定員：40名
+          ## 詳細
+          定員：40名
+    keep:
+      - 本文で確かめた値
+      - 要約の短さ
+    avoid:
+      - どちらが正しいかを推測で決める
+      - 要約から値を消して、ぼかした言い方にする
+  en:
+    direction: Ask the writer whether the summary or the body is right, and correct the other. When copying a value into the summary, copy its unit and condition too.
+    pairs:
+      - before: |
+          Summary: the deadline is May 3.
+          (body) The deadline is May 5.
+        after: |
+          Summary: the deadline is May 5.
+          (body) The deadline is May 5.
+      - before: |
+          ## Overview
+          Seats: 30
+          ## Details
+          Seats: 40
+        after: |
+          ## Overview
+          Seats: 40
+          ## Details
+          Seats: 40
+    keep:
+      - the value confirmed in the body
+      - the summary's brevity
+    avoid:
+      - guessing which value is right
+      - removing the value from the summary and writing something vaguer