ルールの一覧へ

版の並びが前後している

version-order既定で動く日本語 / 英語

変更履歴の見出しや版の一覧で、一つだけ順番から外れた版

例

指摘される文
# 変更履歴 ## 3.2.0 - 2026-09-14 ## 3.1.1 - 2026-07-08 ## 3.3.0 - 2026-06-02 ## 3.0.0 - 2026-03-20
chaff の出力
7:4 「3.3.0」が、前後の版の並びから外れています(前は「3.1.1」)
直した文
# 変更履歴 ## 3.2.0 - 2026-09-14 ## 3.1.1 - 2026-07-08 ## 3.1.0 - 2026-06-02 ## 3.0.0 - 2026-03-20
chaff の出力
指摘なし
この例で使った chaff.yaml
genre: technical/readme

直し方

版の番号を確かめて、書き間違いなら直し、置き場所が違うなら正しい位置へ移してください。

なぜ指摘するのか

変更履歴は新しい版から順に(または古い版から順に)並べるのが決まりです。一つだけ並びから外れた版があると、読み手はどれが最新か、どの変更がどの版に入ったかを取り違えます。版を書き間違えたときや、項目を違う場所に足したときに起きます。見出しや箇条書き、表の行の先頭に書いた版(3.2.0、v3.2.0、[3.2.0])を並びとして読み、並びの向きは多いほうで決めて、その向きの最も長い並びに入らない版を指します。

指摘しないもの

並べた版が三つ未満のもの、上がりと下がりが同じ数で向きが決まらないもの、向きに沿う版が半分以下の一覧(名前順の一覧)、同じ版の繰り返し、文の中の版、コードブロックの中の例、点で三つに区切っていない番号(3.1、22.04)は見ません。末尾が 0 の版(3.1.0)が無く上がっていく並び(1.2.1、1.2.2)は節の番号として numbering-gap が見ます。見出しは同じ深さどうし、箇条書きと表は続いた行どうしを比べます。

止める・ゆるめる

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

強さ(段階)

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

strictエラー
normal注意
relaxed情報

このルールには数える上限がありません。段階は指摘の重さを変えます。relaxed にすると指摘は消えずに一段軽く出ます。

ジャンルごとの動き

既定で動くジャンル
technical/spec, technical/readme, blog/tech, blog/essay, blog/owned-media, docs/manual, docs/faq, docs/glossary
このルールを止めるジャンル
legal/contract, legal/statute, legal/judgment, legal/patent, academic/paper, literature/fiction, literature/essay, literature/poetry, literature/play, speech/address, speech/transcript
このルールが向かず、見ないジャンル
business/proposal, business/report, business/email, business/press-release, business/meeting-notes

ジャンル

指摘の文

「{version}」が、前後の版の並びから外れています(前は「{previous}」)

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