chaffjs 0.18.0 → 0.19.0

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

@@ -23,6 +23,7 @@ how_to_fix:
 levels: { strict: 50, normal: 70, relaxed: 90 }
 
 use_for: [blog, legal, docs, academic, literature, speech]
+sources: [reinhart-2025, zhang-2024]
 
 group: ai-tells
 summary:
@@ -120,3 +121,48 @@ not_flagged:
 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,6 +22,14 @@ how_to_fix:
 
 levels: { strict: 45, normal: 35, relaxed: 25 }
 
+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: [blog, legal, docs, academic, literature, speech]
 
 group: ai-tells
@@ -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 で変えられます）。ビジネス文書と技術文書のジャンルでは見ません。
+  en: Documents with fewer than 5 sections are not checked (min_sections changes it). Business and technical genres do not run this rule.
 level_meaning:
   ja: 節の長さのばらつきが {limit}% 未満なら指摘
   en: reported when section length varies by less than {limit}%

package/rules/sentence-rhythm.yaml

@@ -28,6 +28,7 @@ levels:
   relaxed: 20
 
 use_for: [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

@@ -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/taigen-dome-in-prose.yaml

@@ -44,3 +44,17 @@ not_flagged:
 level_meaning:
   ja: 本文の体言止め {limit} 文まで
   en: up to {limit} noun-ending sentences in the body
+rewrite:
+  ja:
+    direction: 本文で名詞で止めた文に、文書の文体に合わせた述語（です・ます、または、だ・である）を足してください。見出し、箇条書き、表はそのままにします。
+    pairs:
+      - before: 次の課題は費用。
+        after: 次の課題は費用です。
+      - before: 導入は来月から。対象は営業部。
+        after: 導入は来月からです。対象は営業部です。
+    keep:
+      - 見出し、箇条書き、表の体言止め
+      - 文書の文体（です・ます、または、だ・である）
+    avoid:
+      - 文末を「〜となります」「〜になります」に揃えて別の癖を作る
+      - 述語を足すときに強める（「大きな課題です」）

package/rules/total-mismatch.yaml

@@ -24,6 +24,7 @@ how_to_fix:
 levels: { normal: error, relaxed: warning }
 
 use_for: [business, technical, blog, legal, docs, academic, literature, speech]
+sources: [de-marneffe-2008]
 
 group: facts
 summary:

package/rules/undefined-acronym.yaml

@@ -41,6 +41,7 @@ how_to_fix:
 levels: { strict: 1, normal: 3, relaxed: 6 }
 
 use_for: [business, technical, legal, docs, academic, literature, speech]
+sources: [plain-2011, jis-z8301-2019]
 
 group: readability
 summary:

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.'