Context-aware guidance for maintaining and improving CLAUDE.md files. Use when editing CLAUDE.md, discussing documentation structure for AI assistants, or optimizing project instructions.
Context-aware guidance for maintaining and improving CLAUDE.md files. Helps ensure the file stays effective, concise, and follows best practices for LLM instruction files.
| Category | Include | Avoid |
|---|---|---|
| Stack | Technologies, architecture overview | Exhaustive dependency lists |
| Critical Rules | Must-follow behaviors (consolidated) | Duplicate rules across sections |
| Quick Commands | Essential build/run commands | Full command reference |
| File References | Paths to detailed guides | Embedded code that can outdated |
| Common Mistakes | Documented actual failures | Hypothetical warnings |
file:line references insteadLevel 1: CLAUDE.md (~100-150 lines ideal, max 300)
āā Critical rules (must-follow behaviors)
āā Quick start (essential commands only)
āā High-level architecture
āā Pointers to Level 2 and 3
Level 2: Skills (.claude/skills/)
āā Domain-specific quick references
āā Decision trees and workflows
āā "ā Routes to" comprehensive docs
Level 3: Specialized Guides
āā Complete technical documentation
āā Full examples and edge cases
āā Troubleshooting guides
When reviewing CLAUDE.md:
wc -l CLAUDE.md)Find duplicates: Search for repeated concepts
# Find potential duplicates
grep -n "NEVER" CLAUDE.md | head -20
Consolidate rules: Move all critical rules to one section
Replace code with references:
# ā Before (takes 10+ lines)
### Typography
```swift
AnytypeText("Title", style: .uxTitle1Semibold)
AnytypeText("Body", style: .bodyRegular)
Typography ā path/to/TYPOGRAPHY_MAPPING.md
Move narrow guidance to skills: If it applies to < 20% of tasks, it's a skill
Before adding, ask:
# ā WRONG - Adding one-off rules
### Special Note (2025-01-15)
Remember to always check X when doing Y...
# ā
CORRECT - Add to appropriate skill or remove
# ā WRONG - Same rule in 3 places
## Critical Rules: NEVER add AI signatures
## Pre-Commit: NO AI signatures
## PR Format: No "Generated with Claude"
# ā
CORRECT - Single consolidated rule
## Critical Rules
2. **NEVER add AI signatures anywhere** - No Co-Authored-By, no emoji signatures
# ā WRONG - Code will outdated
```swift
Image(asset: .X32.qrCode) // What if asset name changes?
Icons ā Modules/Assets/.../ImageAsset.swift:45
## š Research & Best Practices
**Source**: Based on industry practices and LLM behavior research
### Key Findings
- LLMs handle ~150-200 instructions reliably
- Performance degrades with additional instructions
- Irrelevant context may be ignored entirely (Claude adds "this context may or may not be relevant")
- Code snippets in docs become maintenance burden
- Progressive disclosure reduces context overhead
### Recommended Metrics
| Metric | Target | Max |
|--------|--------|-----|
| Total lines | 100-150 | 300 |
| Code blocks | 2-4 | 6 |
| Critical rules | 3-5 | 10 |
| Sections | 6-8 | 12 |
## š Related
- `.claude/skills/README.md` - Skills system overview
- `.claude/skills/skills-manager/SKILL.md` - Managing the skills system
- Progressive disclosure architecture documentation
---
**Navigation**: This skill helps maintain CLAUDE.md quality. For skills system management, see `skills-manager`. For adding new skills, see `.claude/skills/README.md`.