手順の中に、指示でなく説明の文の手順がある
step-statement-mix既定で動く(情報)英語
英語の番号付きの手順で、命令の形の項目の中に、主語で始まる説明の項目が混ざっている所
例
直し方
読み手のすることを命令の形で書いてください。結果の説明なら、前の手順の後ろの文にするか、手順の外に出します。
なぜ指摘するのか
番号を振った手順は、読み手がそのとおりに手を動かす指示です。「Open the app.」「Run the installer.」の中に「The installer asks for a password.」のような説明の文が混ざると、読み手はそれも自分のすることかと迷います。英語の番号付きの箇条書きで、主語と動詞で始まる項目(The installer asks、You click)が、動詞で始まる指示の項目より少ないとき、少ないほうを指します。日本語の手順の文末(〜します/〜してください と それ以外)は no-mixed-desumasu と list-item-form-mix が見るので、この rule は英語だけです。
指摘しないもの
番号の無い箇条書き、三つに満たない手順、指示が半分に満たない番号付きの箇条書き(用語と説明の一覧、「Faults caused by a drop」のように場合を並べた保証の対象外の一覧など)、短い項目(「Setup」)、動詞の前に札や前置きのある項目(「Guests: …」「On the left bar, select …」)、主語で始まる項目が {limit} 個を超えるか指示より多い手順は見ません。項目の最初の行の最初の文だけを見ます。
止める・ゆるめる
技術的な情報
- 層
- L3
- 状態
- 安定
- 重さ
- 情報
- 対象の言語
- en
- 向いている文章
- technical, docs, blog, legal, academic, literature, speech
- 文書から読み取るもの
- pos
強さ(段階)
chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます(どのジャンルで動くかは下の「ジャンルごとの動き」にあります)。
| strict | 説明の項目が 3 個以下で、指示の項目より少ないとき指摘 |
|---|---|
| normal | 説明の項目が 2 個以下で、指示の項目より少ないとき指摘 |
| relaxed | 説明の項目が 1 個以下で、指示の項目より少ないとき指摘 |
ジャンルごとの動き
- 既定で動くジャンル
- 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
指摘の文
この手順は、ほかの {count} 個の指示と違い、主語で始まる説明の文です
書き直しの深さ(chaff fix-plan --depth): light — 語と文を直す。構成と文体は残す
このページはルールの定義ファイルから作られています:packages/chaff/rules/step-statement-mix.yaml