ルールの一覧へ

二通りに書いた画面の札

ui-label-variant既定で動く(情報)日本語 / 英語

太字や[]の画面の札で、大文字・小文字や空白、「を」「の」だけが違う二通りの書き方

例

指摘される文
# 復元する [復元を開始]を押します。終わらないときは、もう一度[復元を開始]を押します。 失敗したら、前のバックアップを選んで[復元開始]を押します。
chaff の出力
5:20 「復元開始」は、ほかの所では「復元を開始」と書いています
直した文
# 復元する [復元を開始]を押します。終わらないときは、もう一度[復元を開始]を押します。 失敗したら、前のバックアップを選んで[復元を開始]を押します。
chaff の出力
指摘なし
この例で使った chaff.yaml
genre: docs/manual

直し方

画面の文字を確かめて、どちらか一方にそろえてください。

なぜ指摘するのか

手順書で同じボタンを[復元を開始]とも[復元開始]とも書くと、読み手は画面に二つのボタンがあるのかと探します。画面の文字と同じ綴りで書くのが手順書の決まりです。画面の文言が変わったあとに一部だけ直すと起きます。太字か[]で囲んだ札のうち、大文字・小文字、空白、「を」「の」だけが違う二つを同じ札と見て、少ないほうを指します。

指摘しないもの

太字か[]で囲んだ札だけを見ます。かぎ括弧の語、コードの中の語、字の違う札([保存]と[上書き保存])、最初の一字の大文字・小文字だけが違う強調(**Note** と **note**)、語の中の「の」([その他])は比べません。技術文書・手順書・ブログでだけ動きます。

止める・ゆるめる

この一か所だけ黙らせる(文書に書く)
<!-- stet: ui-label-variant — 理由 -->
チームでゆるめる(理由は chaff.yaml にコメントで残ります)
npx chaffjs relax ui-label-variant --why "理由"
チームで止める(chaff.yaml)
rules: ui-label-variant: 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

ジャンル

指摘の文

「{written}」は、ほかの所では「{usual}」と書いています

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