文書の種類ごとにできること
chaff は、文書の種類（ジャンル）ごとに見るところを変えます。ここでは種類ごとに、chaff が何を見つけて何を見つけないのかを、実際の文書と画面で示します。コマンドを使ったことがない人に向けて書いています。
chaff は機械、読んで決めるのは人と AI
chaff は、決まった手順で文章を調べる道具です。同じ文章なら、何度かけても同じ結果が出ます。文章は書き換えません。直すのは書いた人です。
意味を読まないと決まらないこと（結びに中身があるか、など）は、chaff だけでは決めません。
npx chaffjs test を使うと、機械で絞り込んだ箇所だけを AI に送って読ませます。
AI を使うかどうかは選べます。使わなくても、機械の検査はすべて動きます。
手元の文書はどれですか
手元の文書に近いものを選び、そのページに進みます。どのページも、使うジャンルを示し、短い見本の文書に chaff をかけた実際の画面を載せています。
| 手元の文書と読むページ | chaff が見つけるもの |
|---|---|
| 技術記事：Zenn や Qiita に出す技術記事、社内ブログ | 決まり文句の書き出しと結び、生成文に多い形、数の合わない予告、行き先の無いリンク |
| 契約書・利用規約：業務委託契約書、利用規約、プライバシーポリシー | 逆になった期間、合わない合計、無い条への参照、飛んだ条番号、合わない曜日 |
| 社内規程・規則：社内規程、規則、通達 | 飛んだ条番号、無い条への参照、同じ語の二重定義 |
| 仕事のメール：取引先へのメール、手紙 | 長い一文、重なった「させていただく」、二重の敬語、埋め忘れた空欄 |
| 議事録：会議の議事録、議事要旨 | 合わない曜日、飛んだ議題の番号、数の合わない予告、混ざった文末、誰が決めたか無い受け身 |
| 業務報告書：月次報告、白書、社内文書 | 決まり文句の書き出し、重ねた逃げの表現、誰がするのか書いていない受け身、長すぎる一文 |
| 給与明細・請求書・各種の明細：給与明細、旅費精算書、通帳の明細、請求書、健診の結果、成績証明書、納品書 | 合わない差引額・合計・残高、順が逆の日付、2 通りに書いた予約番号や社員番号 |
| 説明書・API の文書：使い方の説明、API の文書、ヘルプ | 行き先の無いリンク、説明の無い画像、飛んだ見出しの深さ、中身の無い節 |
| プレスリリース・お知らせ：プレスリリース、社外や社内へのお知らせ | 合わない曜日、逆になった期間、合わない合計、100% にならない内訳 |
| 論文・要旨：論文、要旨、学会の予稿 | 執筆要項と違う表記、混ざった句読点、無い図への参照 |
どれにも当たらないときは、ジャンルのページで近いジャンルを探します。どの種類でどのルールが動くかも、そこで確かめられます。ジャンルを決めずにかけると、chaff は技術記事として見ます。見た目から別の種類だと分かれば、勧めるジャンルを画面に出します。
準備する
chaff を動かすには、Node.js という道具が要ります。準備は最初の 1 回だけです。
| 順番 | やること |
|---|---|
| 1 | nodejs.org から、LTS と書かれた版を入れます。chaff は Node.js 24 以上で動きます |
| 2 | 文字でコマンドを打つ画面を開きます。Mac は「ターミナル」、Windows は「PowerShell」です |
| 3 | node --version と打ち、Enter を押します。v24 以上の数字が出れば入っています |
| 4 | cd と空白を打ち、文書を置いたフォルダの場所を続けて Enter を押します。Mac ではフォルダを画面に引いてくると場所が入ります |
文書は、拡張子が .md のテキストファイル（Markdown）で保存します。見出しの行は、頭に # を付けます（## 第1条（目的） のように）。
Word の文書なら、本文をテキストエディタに貼り付けて保存します。
npx chaffjs は、chaff を取ってきて動かすコマンドです。ほかに入れるものはありません。初めて打ったときだけ、取ってきてよいかを聞かれます。y を押して進めます。
次に読むページ
- 画面の読み方と、指摘への 3 つの道は、はじめかた にあります。
- 数字や日付の指摘の意味と直し方は、数字と日付の食い違い にあります。
- ルールの強さやジャンルをチームに合わせるには、設定 を読みます。