claude-md-command.md
· 1.1 KiB · Markdown
Raw
Analyze this codebase and create a CLAUDE.md file following these principles:
1. Keep it under 150 lines total - focus only on universally applicable information
2. Cover the essentials: WHAT (tech stack, project structure), WHY (purpose), and HOW (build/test commands)
3. Use Progressive Disclosure: instead of including all instructions, create a brief index pointing to other markdown files in .claude/docs/ for specialized topics
4. Include file:line references instead of code snippets
5. Assume I'll use linters for code style - don't include formatting guidelines
Structure it as: project overview, tech stack, key directories/their purposes, essential build/test commands, and a list of additional documentation files Claude should check when relevant.
Additionally, extract patterns you observe into separate files:
- .claude/docs/architectural_patterns.md - document the architectural patterns, design decisions, and conventions used (e.g., dependency injection, state management, API design patterns). Make sure these are patterns that appear in multiple files.
Reference these files in the CLAUDE.md's "Additional Documentation" section.
Analyze this codebase and create a CLAUDE.md file following these principles:
- Keep it under 150 lines total - focus only on universally applicable information
- Cover the essentials: WHAT (tech stack, project structure), WHY (purpose), and HOW (build/test commands)
- Use Progressive Disclosure: instead of including all instructions, create a brief index pointing to other markdown files in .claude/docs/ for specialized topics
- Include file:line references instead of code snippets
- Assume I'll use linters for code style - don't include formatting guidelines
Structure it as: project overview, tech stack, key directories/their purposes, essential build/test commands, and a list of additional documentation files Claude should check when relevant.
Additionally, extract patterns you observe into separate files:
- .claude/docs/architectural_patterns.md - document the architectural patterns, design decisions, and conventions used (e.g., dependency injection, state management, API design patterns). Make sure these are patterns that appear in multiple files.
Reference these files in the CLAUDE.md's "Additional Documentation" section.