ルールの一覧へ

手順の後に書いた前提

prerequisite-after-step既定で動く(情報)日本語 / 英語

節の番号付きの手順より後にある、「作業を始める前に」「始める前に」で始まる文

例

指摘される文
# 復元する 1. コンソールを開きます。 2. バックアップを選びます。 3. [復元を開始]を押します。 作業を始める前に、注文サービスを止めておきます。
chaff の出力
7:1 手順の前にするべきことを、手順の後に書いています
直した文
# 復元する 作業を始める前に、注文サービスを止めておきます。 1. コンソールを開きます。 2. バックアップを選びます。 3. [復元を開始]を押します。
chaff の出力
指摘なし
この例で使った chaff.yaml
genre: docs/manual

直し方

この文を、手順の前(「始める前に」の節か、手順のすぐ上)に移してください。

なぜ指摘するのか

「作業を始める前に、注文サービスを止めておきます。」が番号付きの手順の後にあると、読み手はそれを読む時には手順を終えています。前提・必要な権限・準備は、手順の前に書くものです。文を足したり節を並べ替えたりしたときに起きます。節の中で、番号付きの手順(三つ以上)より後に「作業を始める前に」「始める前に」で始まる文があるとき指します。

指摘しないもの

番号付きの手順が三つ以上ある節の、その手順より後の文だけを読みます。手順の前にある前提、後の節の手順のための前提(その節の手順より前にあるもの)、「手順 4 の前に」のように一つの手順を名指す文、読点の続かない「始める前に戻すには」、引用やコードの中の手順は指しません。技術文書・手順書・ブログでだけ動きます。

止める・ゆるめる

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

強さ(段階)

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

ジャンル

指摘の文

手順の前にするべきことを、手順の後に書いています

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