md-audit

This skill can write to CLAUDE.md files. After presenting a quality report and getting user approval, it updates CLAUDE.md files with targeted improvements.

Reference Files

• quality-criteria.md - Detailed scoring rubrics per criterion
• templates.md - CLAUDE.md templates by project type
• update-guidelines.md - Rules for proposing and applying updates

Workflow

Phase 1: Discovery

Find all CLAUDE.md files in the repository:

Use Glob to find all CLAUDE.md files:

Patterns: **/CLAUDE.md, **/.claude.md, **/.claude.local.md

File Types & Locations:

Note: Claude auto-discovers CLAUDE.md files in parent directories, making monorepo setups work automatically.

Edge cases:

• Empty or newly-created files: Score as F (0/100) and recommend using the relevant template from templates.md
• Overlapping content across files: Flag duplication and recommend consolidating to the most specific location

Phase 2: Quality Assessment

For each CLAUDE.md file, evaluate against quality criteria. See quality-criteria.md for detailed rubrics.

Quick Assessment Checklist:

Quality Scores:

• A (90-100): Comprehensive, current, actionable
• B (70-89): Good coverage, minor gaps
• C (50-69): Basic info, missing key sections
• D (30-49): Sparse or outdated
• F (0-29): Missing or severely outdated

Phase 3: Quality Report Output

ALWAYS output the quality report BEFORE making any updates.

Format:

## CLAUDE.md Quality Report

### Summary
- Files found: X
- Average score: X/100
- Files needing update: X

### File-by-File Assessment

#### 1. ./CLAUDE.md (Project Root)
**Score: XX/100 (Grade: X)**

| Criterion | Score | Notes |
|-----------|-------|-------|
| Commands/workflows | X/20 | ... |
| Architecture clarity | X/20 | ... |
| Non-obvious patterns | X/15 | ... |
| Conciseness | X/15 | ... |
| Currency | X/15 | ... |
| Actionability | X/15 | ... |

**Issues:**
- [List specific problems]

**Recommended additions:**
- [List what should be added]

#### 2. ./packages/api/CLAUDE.md (Package-specific)
...

Phase 4: Targeted Updates

After outputting the quality report, ask user for confirmation before updating.

Update Guidelines (Critical):

1. Propose targeted additions only - Focus on genuinely useful info:

   • Commands or workflows discovered during analysis
   • Gotchas or non-obvious patterns found in code
   • Package relationships that weren't clear
   • Testing approaches that work
   • Configuration quirks

2. Keep it minimal - Avoid:

   • Restating what's obvious from the code
   • Generic best practices already covered
   • One-off fixes unlikely to recur
   • Verbose explanations when a one-liner suffices

3. Show diffs - For each change, show:

   • Which CLAUDE.md file to update
   • The specific addition (as a diff or quoted block)
   • Brief explanation of why this helps future sessions

Diff Format:

### Update: ./CLAUDE.md

**Why:** Build command was missing, causing confusion about how to run the project.

```diff
+ ## Quick Start
+
+ ```bash
+ npm install
+ npm run dev  # Start development server on port 3000
+ ```

Phase 5: Apply Updates

After user approval, apply changes using the Edit tool. Preserve existing content structure.

User tips to include in the report:

• # key shortcut: During a Claude session, press # to have Claude auto-incorporate learnings into CLAUDE.md
• Keep it concise: CLAUDE.md should be human-readable; dense is better than verbose
• Actionable commands: All documented commands should be copy-paste ready
• Use .claude.local.md: For personal preferences not shared with team (add to .gitignore)
• Global defaults: Put user-wide preferences in ~/.claude/CLAUDE.md

Templates

See templates.md for CLAUDE.md templates by project type.

Common Issues to Flag

1. Stale commands: Build commands that no longer work
2. Missing dependencies: Required tools not mentioned
3. Outdated architecture: File structure that's changed
4. Missing environment setup: Required env vars or config
5. Broken test commands: Test scripts that have changed
6. Undocumented gotchas: Non-obvious patterns not captured

What Makes a Great CLAUDE.md

See templates.md for templates and key principles. In short: concise, actionable, project-specific, with non-obvious gotchas.