社内でしか通じない言葉
internal-jargonchaff.yaml に書いたとき日本語 / 英語
「横展開」「握る」のように、社内でしか通じない言葉。chaff.yaml の jargon に書いた語だけを見ます
例
指摘される文
この取り組みを、ほかの部にも横展開します。
chaff の出力
1:1 「横展開」は社内でしか通じないかもしれません(そういう語が 1 箇所)
直した文
この取り組みを、ほかの部でも同じように始めます。
chaff の出力
指摘なし
この例で使った chaff.yaml
jargon:
- 横展開
直し方
初出のところで普通の言葉に言い換えるか、括弧で説明を添えてください。jargon に辞書形(握る・巻き取る)で書いた動詞は、活用した形(握った・巻き取ります)にも当たります。語幹(巻き取)でも書けます。
なぜ指摘するのか
社内で通じる言葉は、外の人にも半年後の自分にも通じません。何が社内用語かはチームごとに違うので、chaff.yaml の jargon に自分で並べてください。並べていなければ何も言いません。
指摘しないもの
chaff.yaml の jargon に書いた語だけを見ます。何も書かなければ何も言いません。
止める・ゆるめる
この一か所だけ黙らせる(文書に書く)
<!-- stet: internal-jargon — 理由 -->
チームでゆるめる(理由は chaff.yaml にコメントで残ります)
npx chaffjs relax internal-jargon --why "理由"
チームで止める(chaff.yaml)
rules:
internal-jargon: off
技術的な情報
- 層
- L2
- 状態
- 安定
- 重さ
- 注意
- 対象の言語
- 日本語と英語
- 向いている文章
- business, blog, technical, legal, docs, academic, literature, speech
強さ(段階)
chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます(どのジャンルで動くかは下の「ジャンルごとの動き」にあります)。
| strict | 当てはまる語が 1 箇所あれば指摘 |
|---|---|
| normal | 当てはまる語が 1 箇所あれば指摘 |
| relaxed | 当てはまる語が 3 箇所あれば指摘 |
ジャンルごとの動き
- 既定で動くジャンル
- 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
指摘の文
「{matched}」は社内でしか通じないかもしれません(そういう語が {count} 箇所)
このページはルールの定義ファイルから作られています:packages/chaff/rules/internal-jargon.yaml