3 項目の箇条書きばかり
rule-of-three既定で動く(情報)日本語 / 英語
箇条書きがどれも三つの項目で、数を合わせて並べたように見える所
例
指摘される文
# 在庫管理
よい在庫管理の条件です。
- 正確さ
- 速さ
- 安さ
毎日することです。
- 数える
- 記録する
- 見返す
よくある失敗です。
- 数え忘れ
- 記録の漏れ
- 見返さない
chaff の出力
5:1 箇条書き 3 個のうち 3 個が 3 項目です(70% まで)
直した文
# 在庫管理
よい在庫管理の条件です。
- 正確さ
- 速さ
毎日することです。
- 数える
- 記録する
- 見返す
- 月末の棚卸しと突き合わせる
よくある失敗です。
- 数え忘れ
- 記録の漏れ
- 見返さない
chaff の出力
指摘なし
この例で使った chaff.yaml
genre: blog/tech
直し方
数を合わせるために足した項目を消してください。2 つで足りるなら 2 つで。
なぜ指摘するのか
3 つ並べると収まりがよいので、言いたいことが 2 つでも 4 つでも 3 つにされます。
指摘しないもの
箇条書きが 3 つより少ない文書は見ません。ビジネス文書と仕様書(technical/spec)のジャンルでは見ません。
止める・ゆるめる
この一か所だけ黙らせる(文書に書く)
<!-- stet: rule-of-three — 理由 -->
チームでゆるめる(理由は chaff.yaml にコメントで残ります)
npx chaffjs relax rule-of-three --why "理由"
チームで止める(chaff.yaml)
rules:
rule-of-three: off
技術的な情報
- 層
- L1
- 状態
- 安定
- 重さ
- 情報
- 対象の言語
- 日本語と英語
- 向いている文章
- technical/readme, blog, legal, docs, academic, literature, speech
強さ(段階)
chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます(どのジャンルで動くかは下の「ジャンルごとの動き」にあります)。
| strict | 3 項目の箇条書きの割合 50% まで |
|---|---|
| normal | 3 項目の箇条書きの割合 70% まで |
| relaxed | 3 項目の箇条書きの割合 90% まで |
ジャンルごとの動き
- 既定で動くジャンル
- 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
指摘の文
箇条書き {total} 個のうち {count} 個が 3 項目です({limit}% まで)
書き直しの深さ(chaff fix-plan --depth): light — 語と文を直す。構成と文体は残す
根拠にした文献
このページはルールの定義ファイルから作られています:packages/chaff/rules/rule-of-three.yaml