pleaseai/claude-md-management
Tools to maintain and improve CLAUDE.md files - audit quality, capture session learnings, and keep project memory current.
70
88%
Does it follow best practices?
Impact
—
No eval scenarios have been run
Passed
No known issues
templates.mdskills/claude-md-improver/references/
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> |
## ArchitectureGotchas
---
## Template: Project Root (Comprehensive)
```markdown
# <Project Name>
<One-line description>
## Commands
| Command | Description |
|---------|-------------|
| `<command>` | <description> |
## ArchitectureKey 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>Template: Path-Specific Rule
For .claude/rules/*.md files targeting specific paths.
---
paths: src/api/**/*.ts,src/services/**/*.ts
---
# <Rule Name>
<Brief description of when this rule applies>
## Guidelines
- <guideline 1>
- <guideline 2>
## Patterns
<code patterns or examples specific to these paths>Important: Use comma-separated paths, NOT YAML array syntax.
Template: Global Rule
For .claude/rules/*.md files that apply everywhere (no paths: frontmatter).
# <Rule Name>
<Brief description>
## Always
- <always do this>
## Never
- <never do this>Update Principles
When updating any CLAUDE.md:
- Be specific: Use actual file paths, real commands from this project
- Be current: Verify info against the actual codebase
- Be brief: One line per concept when possible
- Be useful: Would this help a new Claude session understand the project?