ルールの一覧へ

ファイルによって違う定義

cross-doc-duplicate-definition既定で動く日本語 / 英語

同じ語を、ファイルによって違う言葉で定義している所

例

指摘される文
# はじめに 「メンバー」とは、料金を払った人のことです。
chaff の出力
3:1 「メンバー」を、一緒に見たほかの 2 ファイルと違う言葉で定義しています(例:a.md)
直した文
# はじめに 「メンバー」とは、ワークスペースに招かれた人のことです。
chaff の出力
指摘なし
一緒に渡したファイル(a.md)。指摘される文と直した文は、それぞれこのファイルと比べます
# 用語集 「メンバー」とは、ワークスペースに招かれた人のことです。

直し方

定義を一か所(用語集や本契約)にまとめ、ほかのファイルからはそこを参照してください。意味を変えているなら、別の語にします。

なぜ指摘するのか

契約書の束や説明書では、同じ語をいくつものファイルで定義することがあります(本契約と別紙、用語集と各ページ)。後から一方だけを直すと、ファイルによって定義が食い違い、どちらの意味で読めばよいか分からなくなります。一度に渡したファイルどうしで、同じ語の定義(「『X』とは、…をいう」"X" means …)の、語の後ろの言葉を比べ、多くのファイルと違う言葉で定義したファイルを指します。全角半角、空白、両端の句読点の違いは問いません。言葉が違っても意味が同じかは機械では決まらないので、確かめる場所を示すだけです。

指摘しないもの

範囲を限った定義(「この条において『X』とは」)と、語の後ろに意味を書かない定義(「以下『X』という。」)は比べません。一つのファイルの中で二度定義した語は、最初の定義で比べます(二度目は duplicate-definition が見ます)。全角半角、空白、両端の句読点だけが違う定義は同じとみなします。

止める・ゆるめる

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

強さ(段階)

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

strictエラー
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

ジャンル

指摘の文

「{term}」を、一緒に見たほかの {count} ファイルと違う言葉で定義しています(例:{example})

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