tuzi-update-claude-md について
コードレビューの指摘や開発上の問題を、再利用可能なプロジェクトルールにまとめる Claude Code スキルです。CLAUDE.md は簡潔に保ち、詳細や例は関連ドキュメントに記録します。
主な機能
- 01問題から汎用ルールを抽出
- 02要約と詳細な説明を分けて記録
- 03プロジェクトとユーザーの EXTEND.md 設定を確認
- 04既存ルールとの重複を確認
- 05優先度に応じてドキュメントを更新
活用シーン
- 01繰り返す不具合を防ぐルールの記録
- 02詳細なコーディング例の追加
- 03独自のドキュメント設定の適用
- 04最近の変更に未記録のルールがないか確認
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ tuziapi/ tuzi-skills --skill tuzi-update-claude-mdインストール後、Claude Code で/tuzi-update-claude-mdを入力して読み込まれたか確認します。
詳細
CLAUDE.md の更新
コードレビューのフィードバックや開発上の問題を分析し、一般的なルールを抽出して、階層化された方針でドキュメントを更新します(CLAUDE.md には要約を、docs/CODING_RULES.md には詳細を記載)。
基本原則
CLAUDE.md は簡潔に保つ必要があります。 要約ルールのみを記載し、各ルールは1~2文にします。
| ドキュメント | 内容 | 行数制限 |
|---|---|---|
CLAUDE.md | 基本的な要約ルール(1~2文) | ≤ 300 行 |
docs/CODING_RULES.md | 詳細ルールと誤り/正しい例 | 制限なし |
docs/FEATURE_FLOWS.md | 機能フローのドキュメント | 制限なし |
パラメーター
$ARGUMENTS:発見した問題やルールの説明(任意)
設定(EXTEND.md)
Bash を使用して、次の優先順位で EXTEND.md が存在するか確認します。
# Check project-level first
test -f .tuzi-skills/tuzi-update-claude-md/EXTEND.md && echo "project"
# Then user-level (cross-platform: $HOME works on macOS/Linux/WSL)
test -f "$HOME/.tuzi-skills/tuzi-update-claude-md/EXTEND.md" && echo "user"
┌──────────────────────────────────────────────────────────┬───────────────────┐ │ Path │ Location │ ├──────────────────────────────────────────────────────────┼───────────────────┤ │ .tuzi-skills/tuzi-update-claude-md/EXTEND.md │ Project directory │ ├──────────────────────────────────────────────────────────┼───────────────────┤ │ $HOME/.tuzi-skills/tuzi-update-claude-md/EXTEND.md │ User home │ └──────────────────────────────────────────────────────────┴───────────────────┘
┌───────────┬───────────────────────────────────────────────────────────────────────────┐ │ Result │ Action │ ├───────────┼───────────────────────────────────────────────────────────────────────────┤ │ Found │ Read, parse, apply settings │ ├───────────┼───────────────────────────────────────────────────────────────────────────┤ │ Not found │ Use defaults │ └───────────┴───────────────────────────────────────────────────────────────────────────┘
EXTEND.md がサポートする設定:CLAUDE.md の行数制限 | ルールのカテゴリ | コミットメッセージの形式
ワークフロー
ステップ 1:情報を収集する
$ARGUMENTS が指定されている場合:説明された問題やルールを解析します。
引数がない場合:どのような問題が見つかったかユーザーに尋ねるか、最近の git diff とコミットメッセージを確認します。
git diff HEAD~3 --stat
git log --oneline -5
ステップ 2:ルールの優先度を評価する
| 優先度 | 基準 | 対応 |
|---|---|---|
| 高 | 頻繁に発生するエラーパターン、深刻なバグの原因となるもの、プロジェクトの基本規約 | CLAUDE.md と CODING_RULES.md の両方に追加 |
| 通常 | まれな問題、特定の状況に限られるもの、詳細な例 | CODING_RULES.md のみに追加 |
| スキップ | 一度限りの誤字、特定の業務ロジックに限定されるもの、すでに記載済みのもの | 記録しない |
ステップ 3:ドキュメントの状態を確認する
wc -l CLAUDE.md
250 行を超えている場合は、追加する前にユーザーに整理を促します。
ステップ 4:docs/CODING_RULES.md を更新する
次の形式を使用して、適切なセクションに追加します。
### [Issue Title]
**Scenario**: [When this issue occurs]
❌ **Wrong**:
\`\`\`typescript
// incorrect code
\`\`\`
✅ **Correct**:
\`\`\`typescript
// correct code
\`\`\`
**Reason**: [Why]
セクションのカテゴリ:TypeScript | React コンポーネント | サービスワーカー | キャッシュとストレージ | API とタスク処理 | UI 操作
ステップ 5:CLAUDE.md を更新する(優先度が高い場合のみ)
1~2文の要約のみを追加します。
N. **Rule Name**: Brief description (1-2 sentences)
場所:## 核心编码规则 または同等のセクションの下。
ステップ 6:重複を確認する
- CLAUDE.md と CODING_RULES.md の両方で、類似する既存ルールを確認します
- 新しいルールを作成するのではなく、既存のルールを補足します
- 重複によるドキュメントの肥大化を避けます
ステップ 7:更新を確認する
概要を表示します。
## Documentation Updated
### docs/CODING_RULES.md
- Section: [section name]
- Added: [rule description]
- Includes: Error/correct examples + explanation
### CLAUDE.md (if applicable)
- Section: [section name]
- Added summary: [rule summary]
### Document Status
- CLAUDE.md: XXX lines (limit 300) ✅/⚠️
- CODING_RULES.md: XXX lines
ステップ 8:コミットする
git add CLAUDE.md docs/CODING_RULES.md
git commit -m "docs: add coding rule - [rule name]"
定期的な整理
CLAUDE.md が 300 行に近づいたら、次の対応を行います。
- 類似するルールを統合します
- 古くなったルールを削除します
- 詳細すぎるルールを CODING_RULES.md に移動します
- 相互参照を更新します
使用例
# With argument
/tuzi-update-claude-md Claude keeps forgetting to add theme='light' to TDesign Tooltip
# Interactive
/tuzi-update-claude-md
拡張機能のサポート
EXTEND.md を使用してカスタム設定を行えます。パスとサポートされるオプションについては、設定セクションを参照してください。