How-To: Projekte anlegen und verwalten¶
Diese Anleitung erklärt, wie Entwicklungsprojekte in LLARS strukturiert und dokumentiert werden.
Warum diese Struktur?¶
Große Features erfordern sorgfältige Planung. Diese Struktur stellt sicher, dass:
- Nichts vergessen wird - Alle Aspekte (DB, API, Frontend, WebSocket) werden durchdacht
- Klare Anforderungen existieren - Bevor Code geschrieben wird, ist klar WAS gebaut werden soll
- Fortschritt sichtbar ist - Jeder kann den aktuellen Stand eines Projekts nachvollziehen
- Wissen erhalten bleibt - Entscheidungen und Designs sind dokumentiert
Die drei Projekt-Dateien¶
1. Konzept-Datei (*-konzept.md)¶
Zweck
Definiert WAS gebaut werden soll - ohne Code!
Inhalt:
| Abschnitt | Beschreibung |
|---|---|
| Ziel | Kurze Beschreibung was erreicht werden soll |
| Anforderungen | Funktionale und nicht-funktionale Requirements |
| Datenbank-Design | Tabellen, Relationen, Felder |
| API-Design | Endpoints, Request/Response Formate |
| WebSocket-Design | Events, Payloads, Rooms |
| Frontend-Design | Komponenten, Layout, UX-Flow |
| Styling | Farben, Skeleton Loading, Design-Linie |
Wichtig
Das Konzept enthält keinen Code! Es beschreibt nur die Anforderungen und das Design.
2. Umsetzungs-Datei (*-umsetzung.md)¶
Zweck
Definiert WIE das Konzept implementiert wird - mit Code!
Inhalt:
| Abschnitt | Beschreibung |
|---|---|
| Abhängigkeiten | Welche Packages/Libraries werden benötigt |
| Datenbank | SQL/ORM Code für Migrationen |
| Backend | Python Code für Routes, Services, Worker |
| Frontend | Vue-Komponenten, Composables |
| Integration | Wie Teile zusammenspielen |
| Testing | Test-Szenarien und Commands |
Tipp
Die Umsetzungs-Datei wird erst erstellt, wenn das Konzept vollständig abgenommen ist.
3. Progress-Datei (*-progress.md)¶
Zweck
Zeigt den aktuellen Stand der Implementierung.
Inhalt:
| Abschnitt | Beschreibung |
|---|---|
| Status-Badge | Aktueller Projektstatus (Konzept/Umsetzung/Fertig) |
| Phasen-Übersicht | Checkboxen für abgeschlossene Meilensteine |
| Git-Commits | Referenzen zu relevanten Commits |
| Offene Punkte | Was noch zu tun ist |
| Changelog | Wichtige Änderungen mit Datum |
Workflow¶
graph TD
A[Feature-Idee] --> B[Konzept erstellen]
B --> C{Konzept Review}
C -->|Änderungen nötig| B
C -->|Abgenommen| D[Umsetzung erstellen]
D --> E[Implementierung]
E --> F[Progress aktualisieren]
F --> G{Fertig?}
G -->|Nein| E
G -->|Ja| H[Status: Abgeschlossen]
style A fill:#e1bee7
style B fill:#fff3cd
style C fill:#fff3cd
style D fill:#cce5ff
style E fill:#cce5ff
style F fill:#cce5ff
style H fill:#d4eddaSchritt 1: Konzept erstellen¶
- Kopiere
templates/konzept-template.md - Benenne es nach deinem Projekt:
mein-feature-konzept.md - Fülle alle Abschnitte aus
- Lasse das Konzept reviewen
Schritt 2: Umsetzung planen¶
- Kopiere
templates/umsetzung-template.md - Benenne es:
mein-feature-umsetzung.md - Schreibe den konkreten Implementierungsplan
- Referenziere das Konzept
Schritt 3: Fortschritt tracken¶
- Kopiere
templates/progress-template.md - Benenne es:
mein-feature-progress.md - Aktualisiere bei jedem Meilenstein
- Füge Git-Commit-Hashes hinzu
Status-Badges¶
Verwende diese Badges am Anfang jeder Datei:
Konzept-Phase¶
!!! warning "📋 Status: Konzept"
Dieses Projekt befindet sich in der **Konzeptphase**.
Das Design wird noch erarbeitet.
Umsetzungs-Phase¶
!!! info "🔧 Status: In Umsetzung"
Dieses Projekt wird aktuell **implementiert**.
Siehe [Progress](mein-feature-progress.md) für Details.
Abgeschlossen¶
!!! success "✅ Status: Abgeschlossen"
Dieses Projekt ist **fertig implementiert**.
Letzte Änderung: 2025-11-28
Namenskonvention¶
| Datei | Format | Beispiel |
|---|---|---|
| Konzept | {feature}-konzept.md |
chatbot-rag-konzept.md |
| Umsetzung | {feature}-umsetzung.md |
chatbot-rag-umsetzung.md |
| Progress | {feature}-progress.md |
chatbot-rag-progress.md |
Tipp
Verwende kurze, beschreibende Namen in Kleinbuchstaben mit Bindestrichen.
Best Practices¶
Konzept schreiben¶
- Ziel in 2-3 Sätzen formulieren
- Alle betroffenen Systeme identifizieren (DB, API, WS, UI)
- User-Stories oder Use-Cases definieren
- Datenmodell vollständig beschreiben
- API-Endpoints mit Request/Response dokumentieren
- UI-Mockups oder Beschreibungen hinzufügen
- Edge-Cases und Fehlerszenarien bedenken
Umsetzung schreiben¶
- Auf Konzept verweisen
- Code-Beispiele für jeden Bereich
- Dateipfade angeben wo Code hingehört
- Abhängigkeiten zwischen Komponenten zeigen
- Test-Befehle dokumentieren
Progress pflegen¶
- Nach jedem Commit aktualisieren
- Git-Hashes für Nachvollziehbarkeit
- Blocker sofort dokumentieren
- Schätzungen für offene Punkte
Integration mit Claude Code¶
Diese Projektstruktur ist optimiert für die Arbeit mit Claude Code:
- Konzept als Kontext: Das Konzept kann Claude als Referenz gegeben werden
- Umsetzung als Anleitung: Claude kann der Umsetzung folgen
- Progress für Kontinuität: Bei neuen Sessions kann Claude den Stand sehen