Der richtige Weg, CLAUDE.md zu verwenden

CLAUDE.md ist eine spezielle Datei, die im Stammverzeichnis eines Projekts abgelegt wird, um KI-Assistenten (wie Claude) wichtige Informationen über Ihr Projekt mitzuteilen. Wenn Sie diese Datei gut schreiben, kann die KI Sie besser verstehen und Ihnen besser helfen.

Warum CLAUDE.md benötigt wird?

Stellen Sie sich vor, Sie haben einen neuen Kollegen. Wie lange brauchen Sie, um ihm Ihr Projekt zu erklären? CLAUDE.md ist die "Projektbeschreibung", die der KI einen schnellen Einstieg ermöglicht.

Die fünf wichtigsten Inhalte von CLAUDE.md

1. Projektübersicht

Beschreiben Sie kurz, was das Projekt macht, welche Probleme es löst und an welche Benutzer es sich richtet.

# Projektübersicht Dies ist ein E-Commerce-Backend-Verwaltungssystem zur Verwaltung von Produkten, Bestellungen und Benutzern.

2. Technologiestack

Listen Sie die wichtigsten Technologien und Frameworks auf, die im Projekt verwendet werden.

`# Technologiestack

Frontend: React + TypeScript
Backend: Node.js + Express
Datenbank: PostgreSQL
Bereitstellung: Docker + Kubernetes`

3. Dateistruktur

Erläutern Sie die Funktion der Hauptverzeichnisse.

# Dateistruktur /src /components - UI-Komponenten /pages - Seiten /utils - Hilfsfunktionen /api - API-Aufrufe

4. Häufig verwendete Befehle

Listen Sie die häufig verwendeten Befehle während der Entwicklung auf.

# Häufig verwendete Befehle npm run dev - Startet den Entwicklungsserver npm run build - Erstellt die Produktionsversion npm run test - Führt Tests aus

5. Regeln

Definieren Sie die Regeln, die die KI beim Schreiben von Code für Sie befolgen soll.

`# Codierungsregeln

Verwenden Sie funktionale Komponenten
Befolgen Sie die ESLint-Konfiguration
Verwenden Sie PascalCase für die Benennung von Komponenten
Verwenden Sie camelCase für die Benennung von Variablen`

Ein vollständiges Beispiel

`# Projektname: Task Manager

Projektübersicht

Eine einfache Aufgabenverwaltungsanwendung, die das Erstellen, Bearbeiten, Löschen und Kategorisieren von Aufgaben unterstützt.

Technologiestack

React 18
TypeScript
Tailwind CSS
Vite

Dateistruktur

/src /components - UI-Komponenten /hooks - Benutzerdefinierte Hooks /types - TypeScript-Typdefinitionen /utils - Hilfsfunktionen

Häufig verwendete Befehle

npm run dev: Startet den Entwicklungsserver
npm run build: Erstellt die Produktionsversion
npm run lint: Code-Überprüfung

Codierungsrichtlinien

Verwenden Sie funktionale Komponenten
Verwenden Sie Tailwind CSS für Stile
Platzieren Sie jede Komponente in einem separaten Ordner`

Tipps

Halten Sie es kurz: Schreiben Sie nicht zu viel, die KI wird auch "müde"
Regelmäßig aktualisieren: Denken Sie daran, CLAUDE.md zu aktualisieren, wenn sich das Projekt ändert
Beispielpriorität: Geben Sie konkrete Codebeispiele an, die effektiver sind als abstrakte Beschreibungen
Konzentrieren Sie sich auf Schwachstellen: Erläutern Sie die Stellen, an denen Fehler wahrscheinlich sind, im Detail

Schreiben Sie CLAUDE.md gut, damit die KI zu Ihrem wertvollen Helfer wird!