ルールの一覧へ

表の見出しの書き方が表ごとに違う

table-header-variant既定で動く(情報)日本語 / 英語

同じ欄の見出しを、表によって「担当者」と「担当」のように書き分けている所

例

指摘される文
| 作業 | 担当者 | | --- | --- | | 発注 | 山田 | | 作業 | 担当 | | --- | --- | | 検品 | 鈴木 |
chaff の出力
5:8 表の見出しを「担当」と書いています(この文書のほかの表は「担当者」。2 箇所のうち 1 箇所が違う)
直した文
| 作業 | 担当者 | | --- | --- | | 発注 | 山田 | | 作業 | 担当者 | | --- | --- | | 検品 | 鈴木 |
chaff の出力
指摘なし
この例で使った chaff.yaml
genre: business/report

直し方

同じ欄なら、文書の多いほうの書き方にそろえてください。本当に別の欄なら、違いが分かる名前にします。

なぜ指摘するのか

同じ欄を、ある表では「担当者」、別の表では「担当」と書くと、読み手は別の欄かと迷い、表を見比べるときに手が止まります。chaff は表の見出しの行と、二列の表の左の欄(項目名)を集め、幅・大文字小文字・空白・ハイフン・中黒をそろえたうえで、名前を変えない字(者・欄・名・等)を外すと同じになる見出しを、同じ欄の書き方と見ます。そのうえで、文書の中で少ないほうの書き方を指摘します。どちらが正しいかは決めません。

指摘しないもの

文字の無い見出し(数や記号だけ)、コードの例の中の表、見出しの違いが名前を変える場合(「日付」と「日時」)は見ません。見出しの中の HTML のタグ(<div style="…">)とその内側の空白は、見える文字でないので比べません。二列の表でなければ、左の欄は見出しとして集めません。

止める・ゆるめる

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

強さ(段階)

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

strict少ないほうの書き方が、その見出しの 50% 以下のとき指摘
normal少ないほうの書き方が、その見出しの 50% 以下のとき指摘
relaxed少ないほうの書き方が、その見出しの 34% 以下のとき指摘

ジャンルごとの動き

既定で動くジャンル
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

ジャンル

指摘の文

表の見出しを「{written}」と書いています(この文書のほかの表は「{usual}」。{of} 箇所のうち {count} 箇所が違う)

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

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