document-directory

Files (1)

• SKILL.md

SKILL.md (first lines)

# Document directory

Claude Code loads subdirectory `CLAUDE.md` files on demand, only when it
reads a file in that subtree. Detailed knowledge sits exactly where it's
relevant without bloating every session.

## When to run

- Doc tier is `app` or `system`. Never for `script` or `tool`.
- After implementation has touched a module substantially enough that a
  future session would benefit from a summary.

## Process

1. **Check for existing subdirectory `CLAUDE.md`.** If one exists,
   update it with what's new — preserve prior content that's still
   accurate.

2. **If none exists, create one covering:**
   - Purpose and responsibility (1-2 sentences).
   - Key architectural decisions (link to ADRs where they exist).
   - Non-obvious patterns or gotchas a future session would have to
     rediscover.
   - Do not repeat root `CLAUDE.md` content — inheritance is automatic.

3. **Keep it short.** A subdirectory `CLAUDE.md` as long as the root
   file has lost the point. Complex modules get an ADR or dedicated doc
   linked from a still-short `CLAUDE.md`.

4. **Commit separately** from implementation unless the project's
   convention says otherwise.

## What this skill must never do

- Never run on script or tool tier projects.
- Never duplicate root `CLAUDE.md` content.
- Never let a subdirectory file grow to root-file length.

From lynchypin/project-onboard, MIT.

More from lynchypin/project-onboard