節の長さが揃いすぎている
section-length-uniformity既定で動く(情報)日本語 / 英語
どの節もほぼ同じ長さに埋めてあり、ひな形を埋めたように見える所
例
指摘される文
# 新しい道具の紹介
## 入れる
公式のページから、使う機械に合った版を選んで入れます。
## 設定する
右上の歯車の印を押して、言語と文書の種類を選びます。
## 招く
左の招待の画面で、仲間の宛先を入れて送ります。
## 確かめる
試しの文書を置いて、指摘が画面に出るかを見ます。
## 更新する
新しい版が出たら、同じ公式のページから入れ直します。
chaff の出力
1:11 節の長さのばらつきが 6% しかありません(35% 以上ほしい)
直した文
# 新しい道具の紹介
## 入れる
公式のページから入れます。
## 設定する
右上の歯車の印を押して、言語と文書の種類を選びます。項目は多いですが、最初に触るのはこの二つだけで足ります。ほかは、使いながら必要になったときに変えてください。
## 招く
左の招待の画面から送ります。
## 確かめる
試しの文書を置いて、指摘が画面に出るかを見ます。
## 更新する
新しい版は同じページにあります。
chaff の出力
指摘なし
この例で使った chaff.yaml
genre: blog/tech
直し方
書くことの少ない節は短いままにしてください。
なぜ指摘するのか
見出しごとに機械的に埋めると、節の長さが揃います。書くことの量は節ごとに違うはずです。
指摘しないもの
中身のある節が 5 より少ない文書は見ません(min_sections で変えられます)。ビジネス文書と仕様書(technical/spec)のジャンルでは見ません。
止める・ゆるめる
この一か所だけ黙らせる(文書に書く)
<!-- stet: section-length-uniformity — 理由 -->
チームでゆるめる(理由は chaff.yaml にコメントで残ります)
npx chaffjs relax section-length-uniformity --why "理由"
チームで止める(chaff.yaml)
rules:
section-length-uniformity: off
技術的な情報
- 層
- L1
- 状態
- 安定
- 重さ
- 情報
- 対象の言語
- 日本語と英語
- 向いている文章
- technical/readme, blog, legal, docs, academic, literature, speech
強さ(段階)
chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます(どのジャンルで動くかは下の「ジャンルごとの動き」にあります)。
| strict | 節の長さのばらつきが 45% 未満なら指摘 |
|---|---|
| normal | 節の長さのばらつきが 35% 未満なら指摘 |
| relaxed | 節の長さのばらつきが 25% 未満なら指摘 |
ジャンルごとの動き
- 既定で動くジャンル
- technical/readme, blog/tech, blog/essay, blog/owned-media
- このルールを止めるジャンル
- 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, business/proposal, business/report, business/email, business/press-release, business/meeting-notes
指摘の文
節の長さのばらつきが {variance}% しかありません({limit}% 以上ほしい)
このページはルールの定義ファイルから作られています:packages/chaff/rules/section-length-uniformity.yaml