Claude Md

Methodology for authoring and maintaining CLAUDE.md. Enforces brevity, relevance, and structure.

majiayu000 0165857 2 files · 2.0 KB Updated 567 repo stars

File contents

CLAUDE.md Authoring

Purpose

Methodology for editing CLAUDE.md that keeps it concise, high-signal, and structurally sound. The guide (patterns/anti-patterns in skill.yaml) is the primary value; the linter (lint-claude-md.sh) is a safety net for quantifiable rules.

Quick Reference

  • Target: <120 lines, 80% relevance per line
  • Structure: Title, behavioral, "Built with:", dirs-only structure, auto-gen table, commands, conventions
  • Rule: Reference material lives in docs/ — CLAUDE.md links to it
task docs:lint-claude-md    # Validate CLAUDE.md structure

Key Principle

Every line in CLAUDE.md must be useful in 80%+ of sessions. If it's reference material, move it to docs/ and link. If Claude can discover it with tools, omit it.

Automation

See skill.yaml for patterns, anti-patterns, and editing procedure. See collaboration.yaml for boundaries with docs-refresh. See sharp-edges.yaml for common pitfalls.

majiayu000/claude-skill-registry-data/tree/main/skills/claude-md-dohernandez-claude-project-skill commit 01658575d4

Frequently asked questions

npx skillmds add majiayu000/claude-md-2