ルールの一覧へ

具体物のない節がある

concrete-evidence-density既定で動く(情報)日本語 / 英語

数字もコードもリンクも無く、読み手が持ち帰れるものの無い節

例

指摘される文
# 改善の報告 ## 成果 問い合わせ対応が大きく良くなりました。お客様からの評判も上々です。担当者の負担も軽くなりました。
chaff の出力
3:6 「成果」の節に数値もコードもリンクもありません(そういう節が 1/1)
直した文
# 改善の報告 ## 成果 問い合わせへの回答が、平均 3 日から 1 日になりました。お客様アンケートの満足度は 72% から 85% に上がりました。担当者の残業は月 10 時間減りました。
chaff の出力
指摘なし
この例で使った chaff.yaml
rules: concrete-evidence-density: strict

直し方

実例を 1 つ足してください。書けないなら、その節は他の節に畳めるかもしれません。

なぜ指摘するのか

数値もコードもリンクも無い節は、読み終えても持ち帰るものがありません。抽象的な説明だけが残ります。仕様書では「error とは何か」のような定義の節が普通にあるので、technical では動かしません。

指摘しないもの

3 文より短い節、索引のように項目を並べた節、文の半分以上が問いか指示(〜してください)の節は見ません。

止める・ゆるめる

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

強さ(段階)

chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます(どのジャンルで動くかは下の「ジャンルごとの動き」にあります)。

strict具体物のない節が 1 個あれば指摘
normal具体物のない節が 3 個あれば指摘
relaxed具体物のない節が 6 個あれば指摘

ジャンルごとの動き

既定で動くジャンル
business/proposal, business/report, business/email, business/press-release
このルールを止めるジャンル
blog/tech, blog/essay, blog/owned-media, 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
このルールが向かず、見ないジャンル
technical/spec, technical/readme

ジャンル

指摘の文

「{word}」の節に数値もコードもリンクもありません(そういう節が {count}/{total})

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