ルールの一覧へ

ファイルによって違う値が書いてある項目

cross-doc-fact-conflict既定で動く日本語 / 英語

同じ項目(料金、版、締切、問い合わせ先)に、ファイルによって違う値を書いた所

例

指摘される文
# よくある質問 月額料金:1,500円
chaff の出力
3:6 「月額料金」が 1,500円 と書かれていますが、一緒に見たほかの 2 ファイルでは 1,200円 です(例:a.md)
直した文
# よくある質問 月額料金:1,200円
chaff の出力
指摘なし
一緒に渡したファイル(a.md)。指摘される文と直した文は、それぞれこのファイルと比べます
# 料金 月額料金:1,200円

直し方

どちらの値が正しいかを確かめて、違うほうを直してください。別のもの(別のプラン、別の版)の値なら、項目名にそれを書き分けてください(「プロプランの月額料金」)。

なぜ指摘するのか

説明書や文書の束では、料金・版・締切・問い合わせ先のような同じ項目を、いくつものページに書きます。値を直したときに一つのページだけ直し忘れると、ページによって値が食い違い、読み手はどれを信じればよいか分かりません。一度に渡したファイルどうしで、「項目:値」「項目は値です」と書いた所と表の升を読み、同じ項目名(全角半角、大文字小文字は揃えて比べます)に、同じ単位で違う値を書いたファイルを指します。メールアドレスと、三つ以上に区切った版(2.4.1、v3)も値として読みます。どちらが正しいかは決めず、その値を書いたファイルの少ないほうを指します。

指摘しないもの

一つのファイルの中で同じ項目に二つ以上の値を書いたファイルは数えません(プランごとの料金のような一覧か、ファイルの中の食い違いで、そちらは fact-conflict が見ます)。ファイルどうしで値が三通り以上に分かれる項目も、一覧と読んで何も言いません。単位の違う値、記録の欄(同じ名前が行の頭に何度も出る欄)、値の後ろに条件が続くもの(「1,200円から」)も比べません。

止める・ゆるめる

この一か所だけ黙らせる(文書に書く)
<!-- stet: cross-doc-fact-conflict — 理由 -->
チームでゆるめる(理由は chaff.yaml にコメントで残ります)
npx chaffjs relax cross-doc-fact-conflict --why "理由"
チームで止める(chaff.yaml)
rules: cross-doc-fact-conflict: off
技術的な情報
層
L3
状態
安定
重さ
注意
対象の言語
日本語と英語
向いている文章
business, technical, blog, legal, docs, academic, literature, speech
文書から読み取るもの
quantities, documents

強さ(段階)

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

normal注意
relaxed情報

このルールには数える上限がありません。段階は指摘の重さを変えます。relaxed にすると指摘は消えずに一段軽く出ます。

ジャンルごとの動き

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

ジャンル

指摘の文

「{label}」が {value} と書かれていますが、一緒に見たほかの {count} ファイルでは {other} です(例:{example})

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