askill
claudemd-maintainer

claudemd-maintainerSafety 95Repository

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.

0 stars
1.2k downloads
Updated 2/5/2026

Package Files

Loading files...
SKILL.md

CLAUDE.md Maintainer (Smart Router)

Purpose

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.

When Auto-Activated

  • Editing or discussing CLAUDE.md
  • Keywords: claude.md, project instructions, onboarding claude, context file
  • Discussing documentation structure for AI assistants

🚨 CRITICAL RULES

  1. Keep under 300 lines - Research shows LLMs handle ~150-200 instructions reliably; performance degrades with more
  2. Never auto-generate - Manually craft each line; auto-generated content often contains noise
  3. Universal applicability only - Remove task-specific or narrow-scope guidance
  4. File references over code snippets - Code embeds become outdated; paths stay accurate

πŸ“Š Effective CLAUDE.md Principles

What To Include (WHAT, WHY, HOW)

CategoryIncludeAvoid
StackTechnologies, architecture overviewExhaustive dependency lists
Critical RulesMust-follow behaviors (consolidated)Duplicate rules across sections
Quick CommandsEssential build/run commandsFull command reference
File ReferencesPaths to detailed guidesEmbedded code that can outdated
Common MistakesDocumented actual failuresHypothetical warnings

What To Exclude

  • Code style guidelines β†’ Use linters instead (SwiftFormat, ESLint, etc.)
  • Exhaustive command references β†’ Point to tool documentation
  • Task-specific instructions β†’ Put in skills or separate docs
  • Code snippets β†’ Use file:line references instead

🎯 Progressive Disclosure Pattern

Level 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

πŸ“‹ Quick Audit Checklist

When reviewing CLAUDE.md:

  • Line count under 300? (wc -l CLAUDE.md)
  • No duplicate rules? (Search for repeated concepts)
  • Code snippets minimized? (Replace with file path references)
  • Narrow-scope items removed? (Move to skills)
  • Critical rules consolidated? (Single authoritative location)
  • File references current? (Paths still valid)
  • Common mistakes documented? (Actual failures, not hypotheticals)

πŸ”„ Optimization Workflow

Reducing Line Count

  1. Find duplicates: Search for repeated concepts

    # Find potential duplicates
    grep -n "NEVER" CLAUDE.md | head -20
    
  2. Consolidate rules: Move all critical rules to one section

  3. Replace code with references:

    # ❌ Before (takes 10+ lines)
    ### Typography
    ```swift
    AnytypeText("Title", style: .uxTitle1Semibold)
    AnytypeText("Body", style: .bodyRegular)
    

    βœ… After (1 line)

    Typography β†’ path/to/TYPOGRAPHY_MAPPING.md

  4. Move narrow guidance to skills: If it applies to < 20% of tasks, it's a skill

Adding New Guidance

Before adding, ask:

  1. Does this apply to most tasks? (If no β†’ skill or specialized doc)
  2. Is there existing guidance? (If yes β†’ consolidate, don't duplicate)
  3. Can a linter/tool enforce this? (If yes β†’ use the tool instead)
  4. Will this code example outdated quickly? (If yes β†’ use file reference)

⚠️ Common Mistakes

Accumulating Hotfixes

# ❌ 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

Duplicating Rules

# ❌ 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

Embedding Code That Outdates

# ❌ WRONG - Code will outdated
```swift
Image(asset: .X32.qrCode)  // What if asset name changes?

βœ… CORRECT - File reference stays accurate

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`.

Install

Download ZIP
Requires askill CLI v1.0+β–Ά

AI Quality Score

95/100Analyzed 2/12/2026

An exceptionally well-structured skill for managing LLM instruction files. It provides clear metrics, actionable workflows, and architectural patterns for maintaining CLAUDE.md files.

95
100
90
95
98

Metadata

Licenseunknown
Version-
Updated2/5/2026
Publishermajiayu000

Tags

ci-cdgithub-actionsllmobservabilityprompting