ルールの一覧へ

挙げた一覧に無い名前

outside-announced-list既定で動く日本語 / 英語

「対応 OS は Windows と macOS」と挙げたあとで、一覧に無い「Linux」に対応すると書いている所

例

指摘される文
対応OSはWindowsとmacOSです。インストールは五分で終わります。Linuxにも対応しています。
chaff の出力
1:38 「Linux」は、1 行目で挙げた一覧(Windows, macOS)にありません
直した文
対応OSはWindowsとmacOSとLinuxです。インストールは五分で終わります。Linuxにも対応しています。
chaff の出力
指摘なし

直し方

一覧が古いなら一覧に足し、後の文が誤りなら直してください。

なぜ指摘するのか

「対応 OS は Windows と macOS です」と挙げたあとに「Linux にも対応しています」と書くと、どちらが本当の一覧なのか読み手は決められません。対応先を足したときに最初の一覧を直し忘れたか、別の製品の文を写したことが多いです。chaff はどちらが正しいかを決めず、一覧に無い名前を指します。一覧を言う語は言語ごとの語彙表にあり、同じ組(対応する OS、対応する言語)の語どうしだけを比べます。

指摘しないもの

一覧を言う語(対応OSは、に対応、版)のすぐ隣に並べた固有名詞だけを読みます。最初に二つ以上の名前を挙げた文を一覧とし、それより前の文は見ません。組の違う語(対応する OS と、対応する言語)は比べません。

止める・ゆるめる

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

強さ(段階)

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

ジャンル

指摘の文

「{name}」は、{listLine} 行目で挙げた一覧({list})にありません

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

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