同じ略語の二通りの展開
acronym-expansion-conflict既定で動く日本語 / 英語
同じ略語を、文書の中で違う名前に展開している所
例
指摘される文
SLA(サービス品質保証)を毎月見直します。障害が続いた月は、SLA(サービスレベル契約)に従って返金します。
chaff の出力
1:32 「SLA」をここでは「サービスレベル契約」と、1 行目では「サービス品質保証」と展開しています
直した文
SLA(サービス品質保証)を毎月見直します。障害が続いた月は、SLA に従って返金します。
chaff の出力
指摘なし
直し方
どちらの名前が正しいかを確かめ、一つに揃えてください。別のものなら、別の略語にします。
なぜ指摘するのか
同じ略語を二か所で違う名前に展開すると、読み手は二つが同じものか別のものか分かりません。片方は書き違いか、別の文書から貼った文であることが多いです。
指摘しないもの
名前の大文字小文字、ハイフン、終わりの複数の s の違いは同じ名前と見ます。英語の名前は、頭文字が略語と揃うときだけ展開と読みます。ハイフンかスラッシュで英数字につないだ符号(CC BY-NC-SA(表示-非営利-継承))の後ろの括弧は符号全体の名前なので、最後の略語の展開とは読みません。
止める・ゆるめる
この一か所だけ黙らせる(文書に書く)
<!-- stet: acronym-expansion-conflict — 理由 -->
チームでゆるめる(理由は chaff.yaml にコメントで残ります)
npx chaffjs relax acronym-expansion-conflict --why "理由"
チームで止める(chaff.yaml)
rules:
acronym-expansion-conflict: off
技術的な情報
- 層
- L3
- 状態
- 安定
- 重さ
- 注意
- 対象の言語
- 日本語と英語
- 向いている文章
- business, technical, blog, legal, docs, academic, literature, speech
強さ(段階)
chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます(どのジャンルで動くかは下の「ジャンルごとの動き」にあります)。
| strict | エラー |
|---|---|
| normal | 注意 |
| relaxed | 情報 |
このルールには数える上限がありません。段階は指摘の重さを変えます。relaxed にすると指摘は消えずに一段軽く出ます。
ジャンルごとの動き
- 既定で動くジャンル
- technical/spec, technical/readme, blog/tech, blog/essay, blog/owned-media, business/proposal, business/report, business/email, business/press-release, business/meeting-notes, legal/contract, legal/statute, legal/judgment, legal/patent, docs/manual, docs/faq, docs/glossary, academic/paper, literature/fiction, literature/essay, literature/poetry, literature/play, speech/address, speech/transcript
指摘の文
「{acronym}」をここでは「{name}」と、{firstLine} 行目では「{first}」と展開しています
書き直しの深さ(chaff fix-plan --depth): light — 語と文を直す。構成と文体は残す
このページはルールの定義ファイルから作られています:packages/chaff/rules/acronym-expansion-conflict.yaml