ルールの一覧へ

見出しの終わりの記号が揃っていない

heading-end-punctuation-mix既定で動く(情報)日本語 / 英語

記号なしの見出しの中に「準備:」「確認。」のように記号で終わる見出しが混ざっている所(またはその逆)

例

指摘される文
# 作業の手引き ## 準備 道具をそろえます。 ## 手順 順に進めます。 ## 確認: 結果を見ます。 ## 片付け 元に戻します。
chaff の出力
11:1 見出し「確認:」だけ「:」で終わっています(ほかの見出しは「準備」など 3 個が「:」「。」なしで終わる)
直した文
# 作業の手引き ## 準備 道具をそろえます。 ## 手順 順に進めます。 ## 確認 結果を見ます。 ## 片付け 元に戻します。
chaff の出力
指摘なし

直し方

見出しの終わりを、多いほうの書き方に揃えてください。記号なしの見出しが多ければ「:」や「。」を外します。

なぜ指摘するのか

ほとんどの見出しが「手順」「注意点」のように記号なしで終わるのに、一つだけ「準備:」「確認。」と記号で終わっていたり、その逆だったりすると、読み手はその見出しだけ別の扱いなのかと迷い、目次でも浮いて見えます。直し忘れや、別の文書から貼った見出しによく出る形です。どちらの書き方が正しいかは決めず、同じ深さの見出しのうち少ないほうを指します。深さごとに比べるので、一段深い見出しをすべて「任意:」のような札にする書き方は指しません。

指摘しないもの

文書の題(最初の一つだけの一番上の見出し)は比べません。同じ深さの見出しが四つ未満の所、記号で終わる見出しと終わらない見出しが同じくらいある文書(少ないほうが四分の一を超える)は指しません。疑問符・感嘆符で終わる見出しは、記号なしと数えます。「…」や「etc.」「Inc.」のように言葉の一部の点で終わる見出しは比べません(点で終わる略語は言語ごとの語彙表にあります)。英語の文書で大文字だけで書いた見出し(「AGENCY:」のような告示の見出し語)は、普通の書き方の見出しとは別に、大文字の見出しどうしで比べます。「:」で終わり、下に文の無い値(住所、電話番号)だけを置いた見出し(連絡先の「電話:」「Phone:」)は、項目の札として札どうしで比べます。

止める・ゆるめる

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

強さ(段階)

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

ジャンル

指摘の文

見出し「{heading}」の終わりの記号が、ほかの見出し(「{example}」など {count} 個)と違います

見出し「{heading}」だけ「{mark}」で終わっています(ほかの見出しは「{example}」など {count} 個が「:」「。」なしで終わる)

見出し「{heading}」だけ「:」「。」なしで終わっています(ほかの見出しは「{example}」など {count} 個が記号で終わる)

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

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