Repository navigation
v0.1.0
最初のリリースです。1.0.0までは、マイナーの変更にもルールIDの削除や意味の変更を含めることがあります(README.mdの「バージョン管理」)。
追加
日本語の文書を共通のルールで書くスキル
Claude Codeに日本語の文書を頼むと、表記や文体が文書ごとに揺れ、そのたびに人の手で直していました。docs-rulesを入れると、Claude Codeは書く前に共通のルールと文書種別ごとの構成を読み、それに沿って書きます。
ルールは87件あり、禁止語、文法、表記、構成、Markdown記法、アクセシビリティにわたります。どのルールにも出典を付けています。主な出典は『公用文作成の考え方』(文化審議会建議)、『JTF日本語標準スタイルガイド』第4.0版、常用漢字表などの内閣告示です。
文書種別:セッションログと提案書
文書の種類によって、書くべき項目と順序は違います。セッションログ(session-log)と提案書(proposal)は、必須セクションと見出しの型を決めてあり、書き漏れを防げます。どちらにも当たらない文書には、共通のルールだけを当てます。
書いた後の点検と書き直し
ルールを読んで書いても、守れていない箇所は残ります。書き終えた文書は、次の順に点検してから出します。
- 機械で判定できる47件のルールは、
evaluators/score.mjsが採点します(textlintとmarkdownlintを使います) - 文脈を読まないと判定できないルールと、文書種別ごとの書き方は、AIが決まった手順で評価します
- 見つかった違反は該当箇所だけを書き直し、最大3回まで繰り返します。直せなかった違反は、文書とは別に報告します
Node.jsがない環境でも、機械の採点を飛ばしてAIの評価だけで使えます。
インストール
入れ方は3通りあります。
~/.claude/skills/への手動での配置npx skills add knk1313/docs-rules- Claude Codeのプラグイン(
/plugin install docs-rules@docs-rules)
手順はREADME.mdの「インストール」を参照してください。