Was macht Ralph TUI PRD Generator?
Erstelle detaillierte Product Requirements Documents, optimiert für die Ausführung durch KI-Agenten über ralph-tui.
Die Aufgabe
- Eine Feature-Beschreibung vom Benutzer erhalten
- 3-5 wesentliche klärende Fragen stellen (mit Buchstabenoptionen) – ein Satz nach dem anderen
- Immer nach Qualitäts-Gates fragen (welche Befehle bestanden werden müssen)
- Nach jeder Antwort bei Bedarf Folgefragen stellen (adaptive Erkundung)
- Eine strukturierte PRD generieren, sobald genügend Kontext vorliegt
- Die PRD in
[PRD]...[/PRD]-Marker für das TUI-Parsing ausgeben
Wichtig: Nicht mit der Implementierung beginnen. Nur die PRD erstellen.
Schritt 1: Klärende Fragen (Iterativ)
Fragen einen Satz nach dem anderen stellen. Jede Antwort sollte Ihre nächsten Fragen beeinflussen. Konzentrieren Sie sich auf:
- Problem/Ziel: Welches Problem wird gelöst?
- Kernfunktionalität: Was sind die wichtigsten Aktionen?
- Umfang/Grenzen: Was soll das Feature NICHT tun?
- Erfolgskriterien: Woran erkennen wir, dass es fertig ist?
- Integration: Wie passt es zu bestehenden Funktionen?
- Qualitäts-Gates: Welche Befehle müssen für jede Story bestanden werden? (ERFORDERLICH)
Fragen wie folgt formatieren:
1. Was ist das Hauptziel dieser Funktion?
A. Benutzer-Onboarding verbessern
B. Benutzerbindung erhöhen
C. Support-Aufwand reduzieren
D. Sonstiges: [bitte angeben]
2. Wer ist der Zielbenutzer?
A. Nur neue Benutzer
B. Nur bestehende Benutzer
C. Alle Benutzer
D. Nur Administratoren
So können Benutzer mit „1A, 2C“ antworten, um schnell zu iterieren.
Frage nach Qualitäts-Gates (ERFORDERLICH)
Immer nach Qualitäts-Gates fragen – diese sind projektspezifisch:
Welche Qualitätsbefehle müssen für jede User Story bestanden werden?
A. pnpm typecheck && pnpm lint
B. npm run typecheck && npm run lint
C. bun run typecheck && bun run lint
D. Sonstiges: [Ihre Befehle angeben]
Soll bei UI-Stories eine Browser-Überprüfung hinzugefügt werden?
A. Ja, Verwenden Sie das dev-browser-Skill zur visuellen Überprüfung
B. Nein, automatisierte Tests reichen aus
Adaptive Befragung
Nach jeder Antwort entscheiden, ob:
- Folgefragen gestellt werden (falls Antworten Komplexität offenbaren)
- Ein neuer Aspekt abgefragt wird (falls der aktuelle Bereich klar ist)
- Die PRD generiert wird (falls genügend Kontext vorliegt)
Normalerweise sind 2-4 Fragerunden erforderlich.
Schritt 2: PRD-Struktur
Die PRD mit folgenden Abschnitten generieren:
1. Einführung/Überblick
Kurze Beschreibung der Funktion und des Problems, das sie löst.
2. Ziele
Spezifische, messbare Zielsetzungen (Aufzählung).
3. Qualitäts-Gates
KRITISCH: Auflistung der Befehle, die für jede User Story bestanden werden müssen.
## Qualitäts-Gates
Diese Befehle müssen für jede User Story bestanden werden:
- `pnpm typecheck` – Typprüfung
- `pnpm lint` – Linting
Für UI-Stories zusätzlich:
- Im Browser mit dem dev-browser-Skill überprüfen
Dieser Abschnitt wird von Konvertierungstools (ralph-tui-create-json, ralph-tui-create-beads) extrahiert und an die Abnahmekriterien jeder Story angehängt.
4. User Stories
Jede Story benötigt:
- Titel: Kurzer, beschreibender Name
- Beschreibung: „Als [Benutzer] möchte ich [Funktion], um [Nutzen] zu erhalten“
- Abnahmekriterien: Überprüfbare Checkliste, was „erledigt“ bedeutet
Jede Story sollte klein genug sein, um in einer fokussierten KI-Agenten-Sitzung implementiert zu werden.
Format:
### US-001: [Titel]
**Beschreibung:** Als [Benutzer] möchte ich [Funktion], um [Nutzen] zu erhalten.
**Abnahmekriterien:**
- [ ] Spezifisches überprüfbares Kriterium
- [ ] Ein weiteres Kriterium
Hinweis: Keine Qualitäts-Gate-Befehle in die Kriterien einzelner Storys aufnehmen – sie werden einmal im Abschnitt „Qualitäts-Gates“ definiert und bei der Konvertierung automatisch angewendet.
Wichtig:
- Abnahmekriterien müssen überprüfbar sein, nicht vage
- „Funktioniert korrekt“ ist schlecht
- „Schaltfläche zeigt Bestätigungsdialog vor dem Löschen an“ ist gut
- Jede Story sollte unabhängig abschließbar sein
5. Funktionale Anforderungen
Nummerierte Liste spezifischer Funktionalitäten:
- „AF-1: Das System muss es Benutzern ermöglichen, …“
- „AF-2: Wenn ein Benutzer auf X klickt, muss das System …“
Seien Sie explizit und eindeutig.
6. Nicht-Ziele (Außerhalb des Rahmens)
Was diese Funktion NICHT umfasst. Kritisch für das Scope-Management.
7. Technische Überlegungen (Optional)
- Bekannte Einschränkungen oder Abhängigkeiten
- Integrationspunkte mit bestehenden Systemen
- Leistungsanforderungen
8. Erfolgsmetriken
Wie wird der Erfolg gemessen?
9. Offene Fragen
Verbleibende Fragen oder Bereiche, die geklärt werden müssen.
Schreiben für KI-Agenten
Die PRD wird von KI-Codierungsagenten über ralph-tui ausgeführt. Daher:
- Explizit und eindeutig sein
- User Stories sollten klein sein (in einer Sitzung abschließbar)
- Abnahmekriterien sollten nach Möglichkeit maschinenüberprüfbar sein
- Spezifische Dateipfade angeben, falls bekannt
- Auf bestehende Codemuster im Projekt verweisen
Ausgabeformat
KRITISCH: Die endgültige PRD in Marker für das TUI-Parsing einpacken:
[PRD]
# PRD: Funktionsname
## Überblick
...
## Qualitäts-Gates
...
## User Stories
...
[/PRD]
Dateibenennung: Das TUI speichert unter ./tasks/prd-[funktionsname].md
Beispielhafter Gesprächsablauf
Benutzer: Erstelle eine PRD für die Integration des Dunkelmodus in das TUI
Assistent: Ich helfe Ihnen, eine PRD für den Dunkelmodus zu erstellen. Lassen Sie mich ein paar Fragen stellen:
-
Was ist das Hauptziel? A. Weniger Augenbelastung bei langen Sitzungen B. An das System-Theme anpassen C. Visuelle Anpassung bieten D. Sonstiges
-
Soll die Einstellung persistent sein? A. Ja, in der Konfigurationsdatei speichern B. Nein, nur für die Sitzung C. Systemeinstellung folgen
Benutzer: 1A, 2A
Assistent: Großartig! Noch ein paar Fragen:
-
Welche Komponenten benötigen Dunkelmodus-Unterstützung? A. Alle TUI-Komponenten B. Nur die Hauptausführungsansicht C. Hauptansicht + Einstellungen D. Sonstiges
-
Welche Qualitätsbefehle müssen für jede Story bestanden werden? A. pnpm typecheck && pnpm lint B. npm run typecheck && npm run lint C. bun run typecheck D. Sonstiges: [Befehle angeben]
-
Soll bei UI-Stories eine Browser-Überprüfung hinzugefügt werden? A. Ja, Verwenden Sie das dev-browser-Skill B. Nein, automatisierte Tests reichen aus
Benutzer: 3A, 4A, 5A
Assistent: Perfekt, ich habe genug, um die PRD zu generieren.
[PRD]
PRD: Dunkelmodus für Ralph TUI
Überblick
Füge dem ralph-tui Dunkelmodus-Unterstützung hinzu, um die Augenbelastung bei langen Orchestrierungssitzungen zu reduzieren. Die Funktion wird auf alle TUI-Komponenten angewendet und die Benutzereinstellung in der Konfigurationsdatei gespeichert.
Ziele
- Angenehmes Betrachten in Umgebungen mit wenig Licht bieten
- Theme-Präferenz über Sitzungen hinweg speichern
- Einheitliche Gestaltung aller TUI-Komponenten sicherstellen
Qualitäts-Gates
Diese Befehle müssen für jede User Story bestanden werden:
pnpm typecheck– Typprüfungpnpm lint– Linting
Für UI-Stories zusätzlich:
- Im Browser mit dem dev-browser-Skill überprüfen
User Stories
US-001: Theme-Konfiguration hinzufügen
Beschreibung: Als Benutzer möchte ich mein bevorzugtes Theme (hell/dunkel) festlegen können, damit es über Sitzungen hinweg bestehen bleibt.
Abnahmekriterien:
-
theme-Feld zum.ralph-tui.yaml-Schema hinzufügen - Werte unterstützen: „light“, „dark“, „system“
- Standard auf „light“ für Abwärtskompatibilität setzen
US-002: Dunkles Theme-Farbschema erstellen
Beschreibung: Als Benutzer möchte ich ein sanft kontrastierendes dunkles Theme, das die Augen schont.
Abnahmekriterien:
- Dunkle Palette mit Grautönen definieren (nicht reines Schwarz)
- Ausreichende Kontrastverhältnisse sicherstellen (WCAG AA)
- Farben funktionieren gut für alle UI-Zustände (ausgewählt, Hover, deaktiviert)
US-003: Theme auf TUI-Komponenten anwenden
Beschreibung: Als Benutzer möchte ich, dass alle TUI-Komponenten meine Theme-Präferenz respektieren.
Abnahmekriterien:
- Header-Komponente verwendet Theme-Farben
- Aufgabenliste verwendet Theme-Farben
- Detail-Panels verwenden Theme-Farben
- Fortschrittsbalken verwendet Theme-Farben
- Dialoge verwenden Theme-Farben
US-004: Theme-Umschalter in den Einstellungen hinzufügen
Beschreibung: Als Benutzer möchte ich Themes aus den TUI-Einstellungen heraus umschalten können.
Abnahmekriterien:
- Theme-Option in der Einstellungsansicht sichtbar
- Änderungen werden ohne Neustart sofort übernommen
- Änderungen werden in der Konfigurationsdatei gespeichert
Funktionale Anforderungen
- AF-1: Die Theme-Einstellung muss aus
.ralph-tui.yamllesbar sein - AF-2: Das Theme muss beim TUI-Start angewendet werden
- AF-3: Theme-Änderungen in den Einstellungen müssen sofort wirksam werden
- AF-4: Jeder Text muss in beiden Themes lesbar bleiben
Nicht-Ziele
- Automatische System-Theme-Erkennung (zukünftige Verbesserung)
- Benutzerdefinierte Farbschemata über hell/dunkel hinaus
- Komponentenspezifische Theme-Überschreibungen
Technische Überlegungen
- Vorhandene OpenTUI-Theming-Funktionen nutzen, falls verfügbar
- Erstellung eines ThemeContext für React-Komponenten in Betracht ziehen
- Neu-Renderings bei Theme-Wechsel minimieren
Erfolgsmetriken
- Alle Komponenten rendern korrekt im Dunkelmodus
- Keine Zugänglichkeitskontrastprobleme
- Theme bleibt über Sitzungen hinweg erhalten
Offene Fragen
- Sollten wir in v2 automatisch die System-Theme-Präferenz erkennen? [/PRD]
Checkliste
Vor der Ausgabe der PRD:
- Klärende Fragen mit Buchstabenoptionen gestellt
- Nach Qualitäts-Gates gefragt (ERFORDERLICH)
- Bei Bedarf Folgefragen gestellt
- Abschnitt „Qualitäts-Gates“ mit projektspezifischen Befehlen enthalten
- User Stories sind klein und unabhängig abschließbar
- User Stories enthalten KEINE Qualitäts-Gate-Befehle (sie sind im Abschnitt „Qualitäts-Gates“ definiert)
- Funktionale Anforderungen sind nummeriert und eindeutig
- Abschnitt „Nicht-Ziele“ definiert klare Grenzen
- PRD ist in
[PRD]...[/PRD]-Marker eingepackt