題や見出しが長すぎる
title-length既定で動く(情報)日本語 / 英語
一目で読めないほど長い題や見出し
例
直し方
見出しには名前だけを残し、条件や説明は本文の最初の文へ移してください。括弧の補足(日付、対象、版)は副題か本文に書きます。番号や対象の付いた正式な題(CA 23-6: …、…もの[本省、2支局](83))は、ほかの文書がその形で引くので縮めず、要点を下の最初の文に書きます。
なぜ指摘するのか
題と見出しは、読者が目で拾って、読むかどうかを決める所です。長いと一目で読めず、目次や検索の結果では途中で切れます。日本語は文字で数え、英字の語は一語を二文字と数えます(「Generator」も「API」も同じ一語)。報告書・プレスリリース・議事録・仕様書・論文は正式な題が長くなるので、上限を上げています。
指摘しないもの
見出しの頭の番号(「第2章」「1.」)は数えません。末尾の括弧の中の番号付きの通し名(「(490: Employee travel)」)も数えず、ほかの文書の題をかぎ括弧で引いた所(「「…の取扱いについて」等の一部改正」)は一つの名前と数えます。英字の語は一語を二文字と数えます。報告書・プレスリリース・議事録・仕様書・論文は上限が高く、法務・文学・話し言葉のジャンルと、見出しが質問の文になる FAQ では見ません。ほかのジャンルでも、?で終わる質問の見出しは、長さが読み手の問いそのものなので見ません。
止める・ゆるめる
技術的な情報
- 層
- L1
- 状態
- 安定
- 重さ
- 情報
- 対象の言語
- 日本語と英語
- 向いている文章
- blog, business, technical, docs, academic, legal, literature, speech
- 文書から読み取るもの
- markdown
強さ(段階)
chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます(どのジャンルで動くかは下の「ジャンルごとの動き」にあります)。
| strict | 題や見出しが 30 文字を超えたら指摘 |
|---|---|
| normal | 題や見出しが 40 文字を超えたら指摘 |
| relaxed | 題や見出しが 50 文字を超えたら指摘 |
次のジャンルは、段階に別の数字を持っています(npx chaffjs explain で確かめられます): business/report, business/press-release, business/meeting-notes, technical/spec, academic
ジャンルごとの動き
- 既定で動くジャンル
- technical/spec, technical/readme, blog/tech, blog/essay, blog/owned-media, business/proposal, business/report, business/email, business/press-release, business/meeting-notes, docs/manual, docs/glossary, academic/paper
- このルールを止めるジャンル
- legal/contract, legal/statute, legal/judgment, legal/patent, docs/faq, literature/fiction, literature/essay, literature/poetry, literature/play, speech/address, speech/transcript
指摘の文
見出し「{heading}」は {count} 文字あります({limit} 文字まで)
題「{heading}」は {count} 文字あります({limit} 文字まで)
「{heading}」は {count} 文字あります({limit} 文字まで)。番号や対象の付いた正式な題なので、縮めずに、要点を下の最初の文に短く書いてください
書き直しの深さ(chaff fix-plan --depth): light — 語と文を直す。構成と文体は残す
このページはルールの定義ファイルから作られています:packages/chaff/rules/title-length.yaml