あいまいな語が多い
vague-word-density既定で動く(情報)日本語 / 英語
「適宜」「必要に応じて」のように、どこまでを読み手に決めさせる語が多い所
例
文書全体の割合を見るルールなので、この例の後ろに指摘のない普通の文章(日本語で 500 字、英語で 200 語ほど)を足して試しています。
直し方
大事なところから、何を・どこまで・いつまでを書いてください。「適宜報告する」は「毎週金曜に報告する」、「必要に応じて」は、どんなときに必要なのかを書きます。
なぜ指摘するのか
「適宜」「適切に」「必要に応じて」「なるべく」は、どこまで・いつまで・何をしたら済むのかを読み手に決めさせます。一つ二つは普通の言い方ですが、重なると、文書の言っていることの多くを読み手が埋めることになり、人によって読み方が変わります。ISO/IEC/IEEE 29148 が要求の文で避ける語として挙げる言い方と同じ種類です。文書の長さに対して多いときだけ指します。語の一覧は言語ごとの語彙表にあります。
指摘しないもの
文書の長さに対して少ないものは指しません。短すぎる文書も測りません。指すのは語のある文ごとに一度で、長い言い方の中の語(in a timely manner の timely)は一つと数えます。英語の法務の文書では、法律や慣行が意味を決めている言い方(reasonable、best efforts、from time to time)の中の語は数えません。要求の文の中の「可能な限り」「必要に応じて」は、要求の書き方として requirement-smell も見ます。すぐ後ろの括弧で中身を書いた語(一定の事項(請求書に書く事項))も数えません。括弧が名前を付けるだけ(以下「本措置」という。)なら数えます。
止める・ゆるめる
技術的な情報
- 層
- L2
- 状態
- 安定
- 重さ
- 情報
- 対象の言語
- 日本語と英語
- 向いている文章
- business, technical, blog, legal, docs, academic, literature, speech
強さ(段階)
chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます(どのジャンルで動くかは下の「ジャンルごとの動き」にあります)。
| strict | 1000 字あたりあいまいな語 1 個まで |
|---|---|
| normal | 1000 字あたりあいまいな語 2 個まで |
| relaxed | 1000 字あたりあいまいな語 4 個まで |
ジャンルごとの動き
- 既定で動くジャンル
- technical/spec, technical/readme, blog/tech, blog/essay, blog/owned-media, business/proposal, business/report, business/email, business/press-release, 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
指摘の文
「{matched}」など、あいまいな語が 1000 字あたり {density} 個あります({limit} 個まで)
書き直しの深さ(chaff fix-plan --depth): light — 語と文を直す。構成と文体は残す
このページはルールの定義ファイルから作られています:packages/chaff/rules/vague-word-density.yaml