ルールの一覧へ

定義したのに使っていない語

unused-definition既定で動く(情報)日本語 / 英語

定義した語が、本文のどこにも出てこない所

例

指摘される文
「本サービス」とは、当社が運営する予約のサイトをいう。利用者は、このサイトを無料で使える。
chaff の出力
1:1 「本サービス」を定義していますが、本文で使っていません
直した文
「本サービス」とは、当社が運営する予約のサイトをいう。利用者は、本サービスを無料で使える。
chaff の出力
指摘なし

直し方

本文で使っていないなら定義を消してください。本文が別の語で同じものを指しているなら、どちらかに揃えます。

なぜ指摘するのか

定義した語が本文に一度も出てこなければ、その定義は読み手に覚えさせるだけで何も決めていません。多いのは、本文で別の語に言い換えたあと、定義だけが残った場合です。本文のほうが定義と違う語を使っていないかも確かめてください。

指摘しないもの

定義の書き方(「X」とは、以下「X」という、規約やポリシーの以下「X」といいます)で書いた語だけを見ます。複数形と所有の形(Services、Seller's)と、見出しの中の語も使用に数えます。英語の動名詞と目的語の句(Exercising your options)は、動詞のほかの形で書いた所(exercise your options)も使用に数えます。同じ語の二つ目の定義は duplicate-definition が言います。法典の一つの条だけの文書で、自分の入っている編・章(「For the purpose of this subchapter」)のために定義した語は、文書にその編・章の見出しが無ければ見ません。その編・章のほかの条が使います。

止める・ゆるめる

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

強さ(段階)

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}」を定義していますが、本文で使っていません

書き直しの深さ(chaff fix-plan --depth): light — 語と文を直す。構成と文体は残す

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