見出しの繰り返し
heading-echo既定で動く(情報)日本語 / 英語
見出しのすぐ後の文が、見出しをほぼそのまま繰り返している所
例
指摘される文
## 経費の精算方法
経費の精算方法について説明します。領収書を添えて、月末までに申請してください。
chaff の出力
3:1 見出し「経費の精算方法」を直後の文がほぼそのまま繰り返しています
直した文
## 経費の精算方法
領収書を添えて、月末までに申請してください。
chaff の出力
指摘なし
直し方
見出しが約束したことの中身から書き始めてください。
なぜ指摘するのか
見出しで言ったことを次の文が繰り返すと、読者はそこで何も受け取れません。見出しに無い数(金額・番号・日付)を述べる文は、見出しの語を繰り返していても中身を渡しているので指摘しません。
指摘しないもの
短い見出し(言葉が少なく、重なりを測れないもの)は見ません。見出しの頭の番号の札(例 3:、Step 3:、1.、第2章)は重なりに数えません。中身の置き場所(リンク、URL、コードで書いたファイルのパス)へ読者を渡す文(詳しくは `docs/api.md` にあります。)は繰り返しではありません。見出しの直後が名前だけの行(レターヘッド)や項目と値の行(担当者:山田)なら、書式の頭で、繰り返しではありません。見出しが扱うものの名前だけの行(「実施要綱について」の下の「実施要綱」、「ご意見をお聞かせください」一覧)は、リンクや添付の札で、繰り返しではありません。行頭の項目名(「## Project Status」の下の「Current project status:Ongoing」)は報告の書式の札なので、重なりは値の側だけで測ります。
止める・ゆるめる
この一か所だけ黙らせる(文書に書く)
<!-- stet: heading-echo — 理由 -->
チームでゆるめる(理由は chaff.yaml にコメントで残ります)
npx chaffjs relax heading-echo --why "理由"
チームで止める(chaff.yaml)
rules:
heading-echo: off
技術的な情報
- 層
- L1
- 状態
- 安定
- 重さ
- 情報
- 対象の言語
- 日本語と英語
- 向いている文章
- blog, business, technical, legal, docs, academic, literature, speech
強さ(段階)
chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます(どのジャンルで動くかは下の「ジャンルごとの動き」にあります)。
| strict | 見出しと直後の文の重なりが 45% 以上なら指摘 |
|---|---|
| normal | 見出しと直後の文の重なりが 60% 以上なら指摘 |
| relaxed | 見出しと直後の文の重なりが 75% 以上なら指摘 |
ジャンルごとの動き
- 既定で動くジャンル
- technical/spec, technical/readme, blog/tech, blog/essay, blog/owned-media, business/proposal, business/report, business/email, business/press-release, business/meeting-notes, academic/paper, speech/address
- このルールを止めるジャンル
- legal/contract, legal/statute, legal/judgment, legal/patent, docs/manual, docs/faq, docs/glossary, literature/fiction, literature/essay, literature/poetry, literature/play, speech/transcript
指摘の文
見出し「{heading}」を直後の文がほぼそのまま繰り返しています
このページはルールの定義ファイルから作られています:packages/chaff/rules/heading-echo.yaml