claude-plugins-official/plugins/claude-md-management/skills/claude-md-improver/references/templates.md

CLAUDE.md Templates

Key Principles

• Concise: Dense, human-readable content; one line per concept when possible
• Actionable: Commands should be copy-paste ready
• Project-specific: Document patterns unique to this project, not generic advice
• Current: All info should reflect actual codebase state

---

Recommended Sections

Use only the sections relevant to the project. Not all sections are needed.

Commands

Document the essential commands for working with the project.

## Commands

| Command | Description |
|---------|-------------|
| `<install command>` | Install dependencies |
| `<dev command>` | Start development server |
| `<build command>` | Production build |
| `<test command>` | Run tests |
| `<lint command>` | Lint/format code |

Architecture

Describe the project structure so Claude understands where things live.

## Architecture

/

/ # / # / # ``` ```

Key Files

List important files that Claude should know about.

## Key Files

- `<path>` - <purpose>
- `<path>` - <purpose>

Code Style

Document project-specific coding conventions.

## Code Style

- <convention>
- <convention>
- <preference over alternative>

Environment

Document required environment variables and setup.

## Environment

Required:
- `<VAR_NAME>` - <purpose>
- `<VAR_NAME>` - <purpose>

Setup:
- <setup step>

Testing

Document testing approach and commands.

## Testing

- `<test command>` - <what it tests>
- <testing convention or pattern>

Gotchas

Document non-obvious patterns, quirks, and warnings.

## Gotchas

- <non-obvious thing that causes issues>
- <ordering dependency or prerequisite>
- <common mistake to avoid>

Workflow

Document development workflow patterns.

## Workflow

- <when to do X>
- <preferred approach for Y>

---

Template: Project Root (Minimal)

# <Project Name>

<One-line description>

## Commands

| Command | Description |
|---------|-------------|
| `<command>` | <description> |

## Architecture

```

Gotchas

---

## Template: Project Root (Comprehensive)

```markdown
# <Project Name>

<One-line description>

## Commands

| Command | Description |
|---------|-------------|
| `<command>` | <description> |

## Architecture

```

Key Files

• <path> -

Code Style

Environment

• <VAR> -

Testing

• <command> -

Gotchas

---

## Template: Package/Module

For packages within a monorepo or distinct modules.

```markdown
# <Package Name>

<Purpose of this package>

## Usage

<import/usage example>

## Key Exports

- `<export>` - <purpose>

## Dependencies

- `<dependency>` - <why needed>

## Notes

- <important note>

---

Template: Monorepo Root

# <Monorepo Name>

<Description>

## Packages

| Package | Description | Path |
|---------|-------------|------|
| `<name>` | <purpose> | `<path>` |

## Commands

| Command | Description |
|---------|-------------|
| `<command>` | <description> |

## Cross-Package Patterns

- <shared pattern>
- <generation/sync pattern>

---

Update Principles

When updating any CLAUDE.md:

1. Be specific: Use actual file paths, real commands from this project
2. Be current: Verify info against the actual codebase
3. Be brief: One line per concept when possible
4. Be useful: Would this help a new Claude session understand the project?