ルールの一覧へ

ファイルによって書き方が違う語

cross-doc-term-variant既定で動く(情報)日本語 / 英語

同じ語を、ファイルによって違う書き方で書いている所(サーバ/サーバー、e-mail/email)

例

指摘される文
# 案内 サーバに接続します。
chaff の出力
3:1 「サーバ」と書いていますが、一緒に見たほかの 2 ファイルでは「サーバー」です(例:a.md)
直した文
# 案内 サーバーに接続します。
chaff の出力
指摘なし
一緒に渡したファイル(a.md)。指摘される文と直した文は、それぞれこのファイルと比べます
# 手順 サーバーを起動します。

直し方

「ほかのファイルの書き方」に直してください。どちらに寄せるかをチームで決めているなら、chaff.yaml の prefer に書いておくと、どのファイルでも決めた書き方で見ます。

なぜ指摘するのか

説明書や文書の束では、一つのファイルの中ではそろっていても、ファイルどうしで書き方が分かれることがあります(あるページは「サーバ」、ほかのページは「サーバー」)。書いた人や書いた時期が違うと起きます。読み手は別のものかと迷い、サイトの検索でも片方を取りこぼします。一度に渡したファイルどうしを比べ、同じ語をファイルによって違う書き方で書いている所を指します。見る書き方は三つです。カタカナ語の語末の「ー」(サーバ/サーバー)、イギリスとアメリカの綴り(colour/color)、英字の語のハイフンの有無(e-mail/email)。どちらが正しいかは決めず、使うファイルの少ないほうを指します。

指摘しないもの

一つのファイルの中で両方の書き方を使っている語は、そのファイルを数えません(ファイルの中の揺れは katakana-long-vowel などが見ます)。違う語どうし(サーバーとブラウザ)は比べません。語末の「ー」の前が 1 音の語(カー)、辞書が固有名詞と知っている語、chaff.yaml の names に並べた名前、引用符の中の英語の綴り、文の途中で大文字で始まる英語の名前も見ません。ハイフンは、一緒に見たファイルのどれかがハイフンで書いた語だけを比べます。

止める・ゆるめる

この一か所だけ黙らせる(文書に書く)
<!-- stet: cross-doc-term-variant — 理由 -->
チームでゆるめる(理由は chaff.yaml にコメントで残ります)
npx chaffjs relax cross-doc-term-variant --why "理由"
チームで止める(chaff.yaml)
rules: cross-doc-term-variant: off
技術的な情報
層
L3
状態
安定
重さ
情報
対象の言語
日本語と英語
向いている文章
business, technical, blog, legal, docs, academic, literature, speech
文書から読み取るもの
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, speech/address, speech/transcript
このルールを止めるジャンル
literature/fiction, literature/essay, literature/poetry, literature/play

ジャンル

指摘の文

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

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