CLAUDE.md Datei Konfigurationsanleitung

Definieren Sie Projektstandards und Einschränkungen über die CLAUDE.md-Datei, damit Claude Code Ihre Projektanforderungen besser versteht und befolgt.

Was ist CLAUDE.md

CLAUDE.md ist die Projektkonfigurationsdatei für Claude Code, die zu Beginn jedes Gesprächs automatisch geladen wird und Teil der Systemaufforderung ist. Durch die richtige Konfiguration dieser Datei können Sie:

  • Projektspezifische Codierungsstandards definieren
  • Tech-Stack- und Framework-Einschränkungen festlegen
  • Codequalitätsstandards etablieren
  • Entwicklungsworkflows standardisieren
  • Architekturentscheidungen dokumentieren

Kern-Konfigurationsvorlage

Grundlegende Vorlagenstruktur

# Projektname

## Projektübersicht

[Kurze Beschreibung des Projektzwecks, der Kernfunktionen und der Zielnutzer]

## Tech-Stack

- Frontend: [Framework und Hauptbibliotheken]
- Backend: [Sprache und Framework]
- Datenbank: [Datenbanktyp]
- Deployment: [Deployment-Plattform]

## Projektstruktur

\```
project/
├── src/ # Quellcode
├── tests/ # Testdateien
├── docs/ # Dokumentation
└── scripts/ # Skriptdateien
\```

## Entwicklungsstandards

[Projektspezifische Codierungsstandards]

## Hinweise

[Projektspezifische Hinweise und Einschränkungen]

Vollständiges Konfigurationsbeispiel

# CLAUDE.md - Projektkonfigurationsdatei

## Allgemeine Regeln (für alle Projekte verbindlich)

### Kommunikationssprache

- Immer vereinfachtes Chinesisch für Denken und Dialog verwenden
- Code-Kommentare auf Englisch, Dokumentation auf Chinesisch

### Dokumentenverwaltung

- Offizielle Dokumentation im Verzeichnis `docs/`
- Diskussionsvorschläge im Verzeichnis `discuss/`
- README kurz halten, detaillierte Dokumentation separat aufbewahren

## Code-Architekturstandards

### Dateigrößenbeschränkungen

- Python/JavaScript/TypeScript: jede Datei nicht mehr als 300 Zeilen
- Java/Go/Rust: jede Datei nicht mehr als 400 Zeilen
- Nicht mehr als 8 Dateien pro Ordner
- Bei Überschreitung Refactoring oder Aufteilung erforderlich

### Codequalitätsindikatoren

Vermeiden Sie folgende Code-Smells:

1. **Rigidität**: System ist schwer zu ändern
2. **Redundanz**: Zu viel duplizierter Code
3. **Zirkuläre Abhängigkeiten**: Module sind gegenseitig abhängig
4. **Fragilität**: Änderungen verursachen Kettenreaktionen
5. **Unklarheit**: Code-Absicht ist nicht klar
6. **Data Clumps**: Datenelemente erscheinen immer zusammen
7. **Überentwicklung**: Unnötige Komplexität

## Tech-Stack-Einschränkungen

### Frontend Tech-Stack

- React 19+ (keine Version 18 oder niedriger verwenden)
- Next.js 15.4+ (keine Version 14 oder niedriger verwenden)
- Tailwind CSS v4 (nicht v3 verwenden)
- TypeScript bevorzugen, JavaScript vermeiden
- CommonJS verbieten, nur ES Modules verwenden

### Backend Tech-Stack

- Node.js 18+
- TypeScript verwenden
- Express/Fastify als Web-Framework
- Prisma als ORM

### Python-Projekte

- uv für Abhängigkeitsverwaltung verwenden (nicht pip/poetry/conda)
- Verzeichnisname für virtuelle Umgebung: `.venv`
- Starke Typisierung, Verwendung von dict vermeiden
- Projektstammverzeichnis übersichtlich halten

## Entwicklungsworkflow

### Skriptverwaltung

- Alle Skripte im Verzeichnis `scripts/`
- `.sh`-Skripte für Start-Stopp-Operationen verwenden
- Keine direkten npm/pnpm/python-Befehle
- Skriptfehler müssen sofort behoben werden

### Protokollverwaltung

- Konfigurationsdateien geben Protokolle aus
- Einheitliche Ausgabe ins Verzeichnis `logs/`
- Zeitstempel und Protokollstufe einschließen
- Fehlerprotokolle separat speichern

### Testanforderungen

- Unit-Test-Abdeckung > 80%
- Kritische Funktionen müssen Integrationstests haben
- Testdateien im Verzeichnis `tests/`
- CI/CD für automatisierte Tests verwenden

## Namenskonventionen

### Dateinamen

- Komponenten: PascalCase (z.B. UserProfile.tsx)
- Hilfsfunktionen: camelCase (z.B. formatDate.ts)
- Konstantendateien: UPPER_SNAKE_CASE (z.B. API_CONSTANTS.ts)
- Stildateien: kebab-case (z.B. user-profile.css)

### Variablennamen

- Variablen/Funktionen: camelCase
- Konstanten: UPPER_SNAKE_CASE
- Klassen/Schnittstellen: PascalCase
- Private Eigenschaften: \_camelCase

## Git-Workflow

### Branching-Strategie

- main: Produktionscode
- develop: Entwicklungscode
- feature/\*: Feature-Branches
- hotfix/\*: Notfall-Bugfix-Branches

### Commit-Konventionen

- feat: Neue Funktion
- fix: Fehlerbehebung
- docs: Dokumentationsaktualisierung
- style: Code-Formatierung
- refactor: Code-Refactoring
- test: Testbezogen
- chore: Build-/Tool-Änderungen

## API-Design-Standards

### RESTful-Prinzipien

- GET: Ressource abrufen
- POST: Ressource erstellen
- PUT: Ressource aktualisieren (vollständig)
- PATCH: Ressource aktualisieren (teilweise)
- DELETE: Ressource löschen

### Antwortformat

\```json
{
"success": true,
"data": {},
"message": "Operation erfolgreich",
"timestamp": "2024-01-01T00:00:00Z"
}
\```

### Fehlerbehandlung

\```json
{
"success": false,
"error": {
"code": "ERROR_CODE",
"message": "Fehlerbeschreibung",
"details": {}
}
}
\```

## Sicherheitsstandards

### Sensible Informationen

- Keine Hardcodierung von Schlüsseln im Code
- Umgebungsvariablen für Konfigurationsverwaltung verwenden
- `.env`-Datei nicht in Git committen
- Abhängigkeiten regelmäßig aktualisieren

### Datenvalidierung

- Datenvalidierung sowohl Frontend als auch Backend
- Schema-Validierungsbibliotheken verwenden (z.B. zod)
- SQL-Abfragen parametrisieren
- XSS- und CSRF-Angriffe verhindern

## Performance-Optimierung

### Frontend-Optimierung

- Lazy Loading für Bilder
- Code-Splitting
- Caching-Strategie
- Virtuelles Scrolling (große Listen)

### Backend-Optimierung

- Datenbankabfrage-Optimierung
- Caching verwenden (Redis)
- API-Antwort-Komprimierung
- Nebenläufigkeitskontrolle

## Deployment-Konfiguration

### Umgebungsvariablen

- development: Entwicklungsumgebung
- staging: Testumgebung
- production: Produktionsumgebung

### Containerisierung

- Docker für Deployment verwenden
- Multi-Stage-Builds für optimierte Image-Größe
- docker-compose für Service-Orchestrierung verwenden

## Monitoring und Protokollierung

### Monitoring-Metriken

- API-Antwortzeit
- Fehlerrate
- Ressourcennutzung
- Nutzerverhalten-Analyse

### Protokollstufen

- ERROR: Fehlerinformationen
- WARN: Warninformationen
- INFO: Allgemeine Informationen
- DEBUG: Debug-Informationen

## Besondere Hinweise

⚠️ **Wichtige Erinnerungen**:

1. Code-Probleme sofort ansprechen
2. Bei Unsicherheit den Benutzer aktiv fragen
3. Code sauber und wartbar halten
4. Bestehende Projektstandards befolgen

Projekttyp-spezifische Vorlagen

React/Next.js-Projekte

## React/Next.js-Projektstandards

### Komponentenstandards

- Funktionskomponenten + Hooks verwenden
- Komponentendatei gleichnamig mit Komponente
- Eine Datei, eine Komponente
- Props mit TypeScript-Interfaces definieren

### State-Management

- Einfacher State: useState
- Komplexer State: useReducer
- Globaler State: Context API / Zustand
- Server-State: TanStack Query

### Styling-Lösung

- Tailwind CSS v4 als Hauptlösung
- CSS Modules als Ergänzung
- Inline-Styles vermeiden
- Responsive Design priorisieren

### Performance-Optimierung

- React.memo verwenden, um unnötiges Rendering zu vermeiden
- useMemo/useCallback für Berechnungsoptimierung
- Dynamische Imports für Code-Splitting
- next/image-Komponente für Bilder verwenden

Python-Projekte

## Python-Projektstandards

### Projektstruktur

\```
project/
├── src/
│ ├── **init**.py
│ ├── main.py
│ ├── models/
│ ├── services/
│ └── utils/
├── tests/
├── .venv/
└── pyproject.toml
\```

### Abhängigkeitsverwaltung

- uv für alle Abhängigkeiten verwenden
- pyproject.toml für Projektkonfiguration definieren
- requirements.txt für Produktionsdeployment
- requirements-dev.txt für Entwicklungsabhängigkeiten

### Typ-Annotationen

- Alle Funktionen müssen Typ-Annotationen haben
- dataclass für Datenstrukturen verwenden
- Mit mypy für Typprüfung kombinieren
- Any-Typ vermeiden

### Asynchrone Programmierung

- async/await priorisieren
- asyncio für Nebenläufigkeitsverwaltung verwenden
- Asynchrone Treiber für Datenbankoperationen
- httpx für HTTP-Anfragen verwenden

Microservice-Projekte

## Microservice-Architekturstandards

### Service-Aufteilung

- Services nach Geschäftsdomänen aufteilen
- Jeder Service unabhängig deployen
- Inter-Service-Kommunikation über API
- Gemeinsamen Code über Paketverwaltung teilen

### API-Gateway

- Einheitliche Eingangsverwaltung
- Authentifizierung und Autorisierung
- Rate-Limiting und Circuit-Breaking
- Request-Routing

### Service-Kommunikation

- HTTP/REST: Synchrone Aufrufe
- Message Queues: Asynchrone Kommunikation
- gRPC: High-Performance-Szenarien
- WebSocket: Echtzeitkommunikation

### Datenverwaltung

- Jeder Service hat eigene Datenbank
- Service-übergreifende Transaktionen vermeiden
- Event-Driven für Konsistenz
- Idempotente Operationen implementieren

Nutzungsempfehlungen

Initialisierungskonfiguration

Verwenden Sie den Befehl /init zur automatischen Generierung der Basiskonfiguration:

> /init

Claude Code analysiert die Projektstruktur und generiert eine initiale CLAUDE.md-Datei.

Kontinuierliche Aktualisierung

Mit der Projektentwicklung die Konfigurationsdatei kontinuierlich aktualisieren:

Architekturentscheidungen dokumentieren

Wichtige technische Entscheidungen aufzeichnen

Tech-Stack aktualisieren

Tech-Stack-Änderungen zeitnah aktualisieren

Standards verfeinern

Bei Problemen Standards zeitnah ergänzen

Workflow optimieren

Entwicklungsprozess basierend auf Praxis optimieren

Teamzusammenarbeit

Sicherstellen, dass alle Teammitglieder die Konfiguration kennen und befolgen:

  • Neue Mitglieder lesen zuerst CLAUDE.md
  • Regelmäßige Review-Updates der Konfiguration
  • Konfigurationsänderungen an alle kommunizieren
  • Praktikabilität der Konfiguration wahren

Best Practices

DO - Empfohlene Praktiken

✅ Einfach und klar halten

  • Regeln klar und verständlich
  • Überkonfiguration vermeiden
  • Fokus auf wichtige Einschränkungen

✅ Mit Projekt synchronisieren

  • Konfiguration spiegelt Ist-Situation wider
  • Veraltete Inhalte zeitnah aktualisieren
  • Nicht mehr gültige Regeln löschen

✅ Auf Wirksamkeit achten

  • Regeln helfen, Effizienz zu steigern
  • Formalismus vermeiden
  • Basierend auf Feedback kontinuierlich verbessern

DON'T - Zu vermeidende Praktiken

❌ Übereinschränkung

  • Keine zu strengen Regeln aufstellen
  • Entwicklern Flexibilität lassen
  • Innovation nicht ersticken

❌ Von Realität losgelöst

  • Nicht blind Konfigurationen anderer Projekte kopieren
  • Regeln müssen zu Teamfähigkeiten passen
  • Tatsächliche Projektanforderungen berücksichtigen

❌ Wartung vernachlässigen

  • Nicht einmal konfigurieren und nie aktualisieren
  • Regelmäßig Konfigurationswirksamkeit überprüfen
  • Ungenutzte Konfigurationen zeitnah bereinigen

💡 Tipp: CLAUDE.md ist die "Verfassung" des Projekts, sie definiert die Verhaltensregeln von Claude Code im Projekt. Die richtige Konfiguration kann Entwicklungseffizienz und Codequalität erheblich steigern, aber vermeiden Sie die Belastung durch Überkonfiguration. Denken Sie immer daran: Konfiguration dient der Entwicklung, nicht Entwicklung der Konfiguration.

Gemeinsam mit der KI bringen wir unbegrenzte Innovationen und endlose Chancen.
Über
Funktionen
Dokumentation
Preispläne
Kontakt