本題に入るまでが長い
preamble-length既定で動く(情報)日本語 / 英語
最初の見出しまでの前置きが長く、本題になかなか入らない所
例
指摘される文
# 来期の出店計画
当社はこれまで、駅前を中心に店を増やしてきました。
この十年で、店の数は二倍になりました。
一方で、郊外の店の売上は伸び悩んでいます。
## 決めたこと
来期は、郊外の二店を閉じ、駅前に一店を開きます。
chaff の出力
3:1 最初の見出しまでに 3 段落あります(2 段落まで)
直した文
# 来期の出店計画
来期は、郊外の二店を閉じ、駅前に一店を開きます。
## 理由
この十年で店の数は二倍になりましたが、郊外の店の売上は伸び悩んでいます。
chaff の出力
指摘なし
直し方
結論を先に書くか、前置きを見出しの下へ移してください。
なぜ指摘するのか
業務文書の読み手は結論を探しに来ています。最初の見出しまでに段落が重なると、探す手間だけが増えます。文の閉じない段落(分類の札、著者の行)と、値が会社名だけの宛先・差出人の欄(英語の To 欄)は数えません。
指摘しないもの
表題より下の見出しが一つもない文書は測りません。法務やブログのジャンルと、手紙・メールでは見ません。本文の語に付けた注(※1 …)の段落は、前置きではなく注なので数えません。
止める・ゆるめる
この一か所だけ黙らせる(文書に書く)
<!-- stet: preamble-length — 理由 -->
チームでゆるめる(理由は chaff.yaml にコメントで残ります)
npx chaffjs relax preamble-length --why "理由"
チームで止める(chaff.yaml)
rules:
preamble-length: off
技術的な情報
- 層
- L1
- 状態
- 安定
- 重さ
- 情報
- 対象の言語
- 日本語と英語
- 向いている文章
- business, legal, docs, academic, literature, speech
- 文書から読み取るもの
- headings
強さ(段階)
chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます(どのジャンルで動くかは下の「ジャンルごとの動き」にあります)。
| strict | 最初の見出しまで 1 段落まで |
|---|---|
| normal | 最初の見出しまで 2 段落まで |
| relaxed | 最初の見出しまで 4 段落まで |
ジャンルごとの動き
- 既定で動くジャンル
- business/proposal, business/report, business/press-release, business/meeting-notes
- このルールを止めるジャンル
- business/email, 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
- このルールが向かず、見ないジャンル
- technical/spec, technical/readme, blog/tech, blog/essay, blog/owned-media
指摘の文
最初の見出しまでに {count} 段落あります({limit} 段落まで)
このページはルールの定義ファイルから作られています:packages/chaff/rules/preamble-length.yaml