Repository navigation
v0.5.0
文書種別を四つ足し、機械の採点の見逃しと誤検出を測って直したリリースです。既存のルールの意味を変えたものがあります。
ルールの意味の変更と移行
このリリースで意味が変わったルールは次のとおりです。前の版に合わせて書いた文書で、新しく指摘が出ることがあります。
| ルール | 変わったこと | 移行の方法 |
|---|---|---|
| NOT-010 送り仮名 | 本則の形だけでなく、許容の形(「売上」「手続」)も通すようにした。代わりに、一つの文書の中で同じ語の書き方が混ざると指摘する | 文書の中で、同じ語の送り仮名をどちらかにそろえる |
| NOT-013 「万」「億」 | 「大きな数」を、1万以上の数と決めた | 「12,000人」は「1万2,000人」と書く |
| NOT-011 外来語の長音 | 告示の用例集にない技術文書の語(「サーバー」「ユーザー」「フォルダー」など33語)も指摘する | 語末の長音符号を付ける。語末が「リ」の語(「メモリ」)は対象外 |
| MKD-001 見出し | 見出しの末尾に閉じる「#」を付けないと明記した | ## 見出し ##を## 見出しにする |
ルールも二つ足しました。どちらも機械で判定します。
- GRM-018 一文の読点は3つまでにする
- NOT-035 漢字を7字以上続けない。法令や組織の名前のような固有名詞はそのまま書きます
追加
ハウツー、チュートリアル、リファレンス、解説の種別
手順書や仕様の説明を書く依頼には、目的の違う書き方が一つの文書に混ざりがちでした。Diátaxisの四つの区分に合わせて、ハウツー(how-to)、チュートリアル(tutorial)、リファレンス(reference)、解説(explanation)の種別を足しました。種別ごとに、必須セクションのスキーマとテンプレートがあります。
改善点をためてIssueにするdocs-rules-feedback
スキルを使っていて見つけた誤検出や、ルールでは直せない違反は、その場で報告に書くだけで消えていました。docs-rulesの報告に「改善点の候補」を書くようにし、docs-rules-feedbackのスキルで候補をためておけるようにしました。「改善点をIssueにして」と頼むと、ためた候補をまとめてIssueの下書きにします。claude.ai用のzipには入れていません。
変更
- 採点の速さ:
score.mjsに複数の文書を一度に渡せるようにしました。textlintの起動が1回で済みます - 判定の拡充:次の書き方も、機械で指摘するようにしました
- 小数点に使った「,」(「1,5秒」)
- 全角スペースと、読点の後ろのスペース
- 全角の「;」
- 「2026.10.23」「2026年05月07日」の形の日付
- 0で埋めていない時刻(「2026-10-23 9:05」)
- 空白だけの画像の代替テキスト
- 「〜だろう」「〜と思われる」
- 「ないとは言えない」
- 箇条書の中の敬体の混在
- 「十」を含む漢数字(「二十人」)
- 「ゞ」「ヾ」の繰り返し符号
- 送り仮名の活用した形(「終った」)
- ルールの文言:次のルールに、判断の境目を書き足しました
- FW-002:「取組を行う」は「取り組む」と書く
- NOT-008:題名と法令の引用は、元の表記のまま書く
- GRM-002:本文につながった見出しも、文の長さに数える
- GRM-003:短い語の列挙は、文の中に書いてよい
- 利用条件:README.mdの利用条件に、テストで使うデジタル庁の政策ページを足しました
修正
機械の採点を、ルールごとの違反した文と直した文の対245組と、デジタル庁の政策ページの99段落で測りました。見つかった誤検出を直しています。
- 「〜を行う」を、FW-002に加えてFW-001(「〜することができる」)でも重ねて指摘していた
- 文末の常体と敬体の混在で、「だ。」と「ください。」を数えていなかった
- 「表示が崩れる不具合が見つかった」のように、別々の述語に掛かる「が」を、助詞の連続として指摘していた
- 「生活に密接に関わる」の「密接に」の「に」を、助詞として数えていた
- 「2025 年度」のように、スペースを挟んだ年号に桁区切りを求めていた
測った結果は、node tests/corpus/report.mjsで表にして出せます。対の文では、245組のうち242組の違反を見つけます。直した文での誤検出は1件です。