agentleFS
serejarisserejaris/ris-claude-code/skills/claude-md-writer/SKILL.md

claude-md-writer

Skill243 starsChanged 3 months agoMITView on GitHub

Use when creating or refactoring CLAUDE.md files - enforces best practices for size, structure, and content organization

2 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

5 rules. About 0 are common, 2 are distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use /memory command to see currently loaded files.

    line 34
  2. Distinctive:

    Use YAML frontmatter for file-type-specific rules:

    line 101
  3. Very specific:

    Run /init for base CLAUDE.md

    line 139
  4. Very specific:

    Create .claude/rules/ for domain-specific docs

    line 142
  5. Distinctive:

    Keep main file < 100 lines

    line 143

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

CLAUDE.md Writer

Creates and refactors CLAUDE.md files following official Anthropic best practices (2025).

Golden Rules

RuleWhy
CLAUDE.md < 200 linesLoads on EVERY request, costs tokens
Rules files < 500 lines eachOfficial recommendation per file
Critical rules FIRSTTop = highest priority
Modular rules → .claude/rules/Conditional loading, organized
Use paths: frontmatterLoad rules only for matching files
No linting rulesUse ESLint/Prettier/Biome instead
Pointers over copiesFiles change, references stay valid

Memory Hierarchy

Claude Code loads memory in this order (higher = higher priority):

PriorityTypeLocation
HighestEnterprise/Library/Application Support/ClaudeCode/CLAUDE.md
↓Project./CLAUDE.md or ./.claude/CLAUDE.md
↓Rules./.claude/rules/*.md (conditional)
↓User~/.claude/CLAUDE.md
LowestLocal./CLAUDE.local.md (gitignored)

Use /memory command to see currently loaded files.

3-Tier Documentation System

Official recommendation for large projects:

TierLocationLoadsTarget
1. FoundationCLAUDE.mdAlways< 200 lines
2. Component.claude/rules/{component}/When working in component< 500 lines
3. FeatureCo-located with codeWhen working on featureAs needed

Example structure:

.claude/
├── CLAUDE.md                 # Tier 1: always loaded
└── rules/
    ├── database.md           # Tier 2: SQL, migrations
    ├── api.md                # Tier 2: API patterns
    └── frontend/             # Tier 2: subdirectory
        ├── components.md     # paths: src/**/*.tsx
        ├── layout.md         # paths: src/pages/**/*.tsx
        └── tokens.md         # paths: **/*.tsx

Structure Template

# Project Name

One-line description.

## Commands

- `npm run dev` - Development
- `npm run build` - Production
- `npm run test` - Tests

## Architecture

| Path | Purpose |
|------|---------|
| `lib/` | Core logic |
| `app/api/` | API routes |

## Key Patterns

**Pattern Name**: One-line explanation.

## Database (if applicable)

| Table | Key Fields |
|-------|------------|

## Modular Docs

See `.claude/rules/` for:
- `database.md` - queries, schema
- `deploy.md` - deployment

## Tech Stack

One line: Next.js 15, PostgreSQL, TypeScript

Conditional Rules (Path-Specific)

Use YAML frontmatter for file-type-specific rules:

---
paths: "src/api/**/*.ts"
---

# API Rules

- All endpoints must validate input
- Use standard error format

Glob Patterns

PatternMatches
**/*.tsAll .ts files anywhere
src/**/*All files under src/
*.mdMarkdown in project root
src/components/*.tsxComponents in specific dir

Combining Patterns

# Multiple extensions
paths: "src/**/*.{ts,tsx}"

# Multiple directories
paths: "{src,lib}/**/*.ts, tests/**/*.test.ts"

Note: Wrap patterns in quotes for YAML safety.

Rules with paths: only load when working with matching files → saves tokens.

Workflow: New Project

  1. Run /init for base CLAUDE.md
  2. Review and trim generated content
  3. Identify critical rules — what breaks if ignored?
  4. Create .claude/rules/ for domain-specific docs
  5. Keep main file < 100 lines

Workflow: Refactor Existing

  1. Count lines — if > 300, must split
  2. Find task-specific content — SQL, debugging, deploy → extract
  3. Create .claude/rules/:
    • database.md - queries, schema, connection
    • deploy.md - deployment process
    • messaging.md - integrations (Telegram, etc.)
  4. Use @file references — don't duplicate
  5. Keep in CLAUDE.md — only what applies to EVERY task

What Goes Where

ContentLocation
Project descriptionCLAUDE.md
Critical constraintsCLAUDE.md (top!)
Quick start (3 commands)CLAUDE.md
Architecture overviewCLAUDE.md
Key patterns (1-liners)CLAUDE.md
SQL queries/schema.claude/rules/database.md
Deployment steps.claude/rules/deploy.md
API documentation.claude/rules/api.md
Git workflow.claude/rules/git.md
Personal preferencesCLAUDE.local.md (gitignored)
Code style rules.eslintrc / biome.json (NOT docs)

Import Syntax

Reference files instead of duplicating:

@README.md
@docs/architecture.md
@~/.claude/snippets/common.md
  • Relative: @docs/file.md
  • Absolute: @~/path/file.md
  • Max depth: 5 hops

CLAUDE.local.md

Personal project settings (auto-gitignored):

# My Local Settings

- Prefer verbose output
- Run tests after every change
- My worktree location: .trees/

Common Mistakes

MistakeFix
500+ linesSplit into .claude/rules/
SQL examples inline→ rules/database.md
"Run prettier" rulesUse tool config files
Full API docs→ rules/api.md
Deployment instructions→ rules/deploy.md
Code in CLAUDE.mdUse @file:line references
Negative rules onlyAdd alternatives: "Don't X; use Y instead"

Quality Checklist

Before finishing:

  • CLAUDE.md < 200 lines?
  • Each rules file < 500 lines?
  • Critical rules at top?
  • No task-specific content in main file?
  • No code style rules (use ESLint/Prettier)?
  • .claude/rules/ for domain-specific docs?
  • Subdirectories for components (frontend/, backend/)?
  • paths: frontmatter for conditional loading?
  • @ references instead of duplication?
  • CLAUDE.local.md for personal prefs?

Useful Commands

CommandPurpose
/initGenerate initial CLAUDE.md
/memoryView loaded memory files

Sources

Official:

  • code.claude.com/docs/en/memory (Memory management, paths, globs)
  • anthropic.com/engineering/claude-code-best-practices
  • claude.com/blog/using-claude-md-files

Community:

  • thedocumentation.org/claude-code-development-kit (3-Tier System)
  • claudefa.st/blog/guide/mechanics/rules-directory
  • humanlayer.dev/blog/writing-a-good-claude-md

Updated: Jan 2026

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.