Projekt-Dokumentation nach Hub-Pattern erstellen und pflegen: docs/{bereich}/general.md mit Code-Pfaden, Status, Trigger-Wörtern. Nutze bei: 'Doku anlegen', 'Docs strukturieren', 'wo finde ich was', 'Code-Map', 'Projekt-Doku', 'Modul dokumentieren'.
Du erstellst und pflegst eine strukturierte Projektdokumentation die Claude (und Menschen) sofort zeigt, wo welche Dateien zu finden sind.
Jedes Modul/Feature bekommt eine Hub-Datei (docs/{bereich}/general.md) die als Einstiegspunkt dient:
Plus: Eine zentrale Lookup-Tabelle in CLAUDE.md die alle Hub-Dateien mit Trigger-Wörtern listet.
Trigger: Projekt hat keine docs/ Struktur oder /docs-structure init.
general.mdCLAUDE.md die zentrale Tabelle ergänzendocs/patterns/ mit Templates und Regeln# Module erkennen
ls app/Http/Controllers/*/ 2>/dev/null
ls app/Services/*/ 2>/dev/null
ls app/Models/ 2>/dev/null
find resources/views -maxdepth 1 -type d 2>/dev/null
ls app/Jobs/*/ 2>/dev/null
Trigger: Neues Feature/Modul erstellt oder /docs-structure {bereich}.
docs/{bereich}/general.md nach TemplateCLAUDE.mdTrigger: Nach Code-Änderungen oder /docs-structure update.
git diff --name-only HEAD~5Erstelle als docs/{bereich}/general.md:
# {Titel}
> **Bereich:** {bereich-slug}
> **Letzte Aktualisierung:** {YYYY-MM-DD}
> **Status:** {aktiv | geplant | archiviert}
## Überblick
{1-3 Sätze: Was ist das, was tut es, warum existiert es}
## Status
- ✅ {Was fertig ist}
- 🔄 {Was in Arbeit ist}
- ⬚ {Was geplant/offen ist}
## Code-Pfade
| Typ | Pfad |
|---|---|
| Controller | `app/Http/Controllers/{...}` |
| Service | `app/Services/{...}` |
| Model | `app/Models/{...}` |
| Enums | `app/Enums/{...}` |
| Views | `resources/views/{...}` |
| Routes | `routes/web.php:L{x}-{y}` |
| Tests | `tests/{...}` |
| Config | `config/{...}` |
| Lang | `lang/{de,en}/{...}.php` |
| Jobs | `app/Jobs/{...}` |
| Migrations | `database/migrations/{...}` |
## Relevante Enums
| Enum | Werte | Zweck |
|---|---|---|
| `{EnumName}` | {wert1, wert2} | {Beschreibung} |
## Scheduled Tasks & Commands
| Command / Schedule | Wann | Zweck |
|---|---|---|
| `{command}` | {Zeitplan} | {Beschreibung} |
## Externe APIs / Services
| Service | Config | Zweck |
|---|---|---|
| {Name} | `config/{...}` | {Beschreibung} |
## Abhängigkeiten
- → **nutzt:** {andere Module/Services}
- ← **genutzt von:** {wer ruft dieses Modul auf}
## Ablauf
{Hauptflow als nummerierte Schritte}
## Erweiterung
### {Typische Aufgabe: z.B. "Neuen Check hinzufügen"}
1. {Schritt 1}
2. {Schritt 2}
Erstelle/ergänze diesen Abschnitt in der Projekt-CLAUDE.md:
## Dokumentation
**Regel:** Lies `docs/{bereich}/general.md` wenn du an einem Bereich arbeitest.
| Bereich | Hub-Datei | Trigger-Wörter |
|---|---|---|
| {Bereich} | `docs/{slug}/general.md` | {Wort1, Wort2, Wort3} |
Trigger-Wörter: Die Begriffe die ein User oder Claude verwenden würde wenn es um diesen Bereich geht. Beispiele:
Erstelle docs/patterns/ mit:
docs/patterns/development.md – Globale Entwicklungsregeln:
# Entwicklungsregeln
## 1. Test-Pflicht
Kein Feature ohne Tests. Gibt es keine Tests für den berührten Bereich, neue erstellen.
## 2. Doc Auto-Update
Bei Änderungen an einem Modul → zugehörige `general.md` prüfen und aktualisieren:
- Controller/Service/Model verschoben/erstellt → Code-Pfade-Tabelle prüfen
- Enum hinzugefügt/entfernt → Enum-Tabelle prüfen
- Scheduled Task geändert → Tasks-Tabelle prüfen
- Feature fertig → Status-Sektion updaten (⬚ → 🔄 → ✅)
## 3. Neue Features → Doc anlegen
Neues Feature? → prüfen ob Doc existiert, sonst nach Template anlegen.
## 4. Boy Scout Rule
Docs besser hinterlassen als vorgefunden.
docs/patterns/doc-template.md – Das Hub-Datei Template (wie oben).
ls {pfad}docs/
├── patterns/ # Globale Regeln + Templates
│ ├── development.md
│ └── doc-template.md
├── auth/ # Login, Register, 2FA, Rollen
├── billing/ # Payment, Subscriptions, Credits
├── {feature}/ # Pro Feature-Modul
│ ├── general.md # Hub-Datei
│ └── {detail}.md # Detail-Docs bei Bedarf
└── infrastruktur/ # Hosting, Deploy, Queue, Redis
docs/
├── patterns/
├── theme/ # Child-Theme, Templates, Bricks
├── plugins/ # Custom Plugins, ACF, Polylang
├── content/ # CPTs, Taxonomies, Menus
└── hosting/ # Server, Caching, Updates
Nach Abschluss:
Dokumentation erstellt/aktualisiert. {X} Hub-Dateien, {Y} Code-Pfade dokumentiert. Claude findet jetzt automatisch die richtige Datei anhand der Trigger-Wörter in CLAUDE.md.