writing-rules について
writing-rulesは、文章の規則を用途別のサイドカーファイルに分け、Markdownの書き込み時にPreToolUseフックで該当ルールを注入します。ドキュメント、エージェント用ファイル、Gitテキストの規約を統一したいチーム向けです。
主な機能
- 01対象別にルールファイルを分割
- 02書き込み時に該当ルールを注入
- 03指定ディレクトリとファイルを除外
- 04変更ファイル内のMermaid図を検査
活用シーン
- 01READMEやドキュメントの執筆
- 02エージェント指示ファイルの作成
- 03ブランチで変更したMermaid図の検査
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/インストール後、Claude Code で/writing-rulesを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
rules/all.mddense.mdgit.mdplain.mdscripts/check-mermaid.mjsdefault-branch.mjsinject-writing-rules.mjs詳細
ライティングルール
ルールは一元管理し、ハブから同期される1つのコピーを使います。更新するのはここだけで、利用側では更新しません。適用方法はリポジトリによって異なりますが、ルール自体は変わりません。
ルールはスタイルごとにサイドカーファイルに分かれているため、該当するものだけが挿入されます。
- rules/all.md — すべてのファイルが対象：読者、用語とリンク、使用禁止リスト、記述する場所
- rules/plain.md — 人が読むものが対象：README、ドキュメント、コードコメント
- rules/dense.md — エージェントだけが読むものが対象：CLAUDE.md、AGENTS.md、スキルファイル、エージェント向けドキュメント。両方が適用される場合は、dense が優先されます
- rules/git.md — コミット、PR、issue が対象。形式は setup-repo のコミットゲートによって適用されます
手作業で文章をレビューまたは執筆しますか？上記のサイドカーファイルを読んでください。このファイルにはルールが記載されていません。
書き込み操作時の挿入
scripts/inject-writing-rules.mjs は PreToolUse フックです。ファイル書き込みツールを呼び出すたびに、パスに応じたルール（all と plain|dense）を追加のコンテキストとして出力するため、ライターはこのスキルを読み込まなくてもルールを確認できます。/setup-repo はこれを .claude/settings.json に設定します。対象は Markdown ファイルのみです。node_modules、.temp/、同期された .claude/skills／.claude/rules ツリーは対象外です。
Mermaid チェック
scripts/check-mermaid.mjs は、ブランチで変更された .md、.mdx、.mmd ファイル内のすべての mermaid 図を解析します。verify スキルの push ステージで実行されます。リポジトリの mermaid と jsdom の devDependencies が必要です。/setup-repo がそれらをインストールします。