Kapitel 3

PRD und dokumentationsgetrieben

Beherrschen Sie die Kernideen der dokumentengetriebenen Entwicklung, lernen Sie, KI zur Unterstützung beim Schreiben von PRDs einzusetzen, entwickeln Sie strukturierte Denkweisen und machen Sie Dokumente zum Kompass der Entwicklung.

Kernaussage: Dokumentation ist Kontext

Im Zeitalter des KI-Programmierens,Dokumentation ist keine Last, sondern der Kontext, damit KI Anforderungen versteht。 Ein gutes PRD ermöglicht es der KI, Anforderungen genau zu verstehen und Code zu generieren, der den Erwartungen entspricht. Nachdem wir uns im vorherigen Kapitel den VibeCoding-Workflow angesehen haben, lernen wir nun, wie man KI-lesbare Dokumentation schreibt.

Warum PRDs benötigt werden

In der traditionellen Entwicklung war das PRD ein Kommunikationswerkzeug für das Team. Im Zeitalter des KI-gestützten Programmierens ist das PRDDie KI versteht den Kontext der Anforderungen

Traditionelle Entwicklung

  • • PRD dient der Teamkommunikation
  • • Das Verständnis der Anforderungen beruht auf menschlichen Diskussionen
  • • Dokumentation und Code können leicht auseinanderdriften
  • • Änderungen müssen manuell synchronisiert werden

Das Zeitalter der KI-Programmierung

  • PRD ist der Kontext für KI
  • • KI liest das PRD direkt und generiert Code
  • • Dokumentation als Code, Versionssynchronisierung
  • • Änderungen lösen automatisch Code-Updates aus

Wert durch Dokumentation

Nacharbeit reduzieren: Zuerst die Dokumentation schreiben und die KI diese dann vor dem Programmieren verstehen lassen, um Missverständnisse zu vermeiden
Die Qualität verbessern: Strukturierte Dokumente ermöglichen es der KI, genaueren Code zu generieren
Rückverfolgbarkeit:Dokumentversionierung, klare Änderungshistorie
Teamzusammenarbeit: Dokumentation ist die gemeinsame Sprache des Teams und reduziert Kommunikationskosten

Strukturierte Denkmethode: Sequential Thinking

Ein PRD zu schreiben ist nichts, was über Nacht geschieht; was nötig ist, istStrukturiertes Denken. Verwenden Sie die Methode Sequential Thinking, um komplexe Probleme in handhabbare Schritte zu zerlegen.

Sequential-Thinking-Workflow

1

Problemzerlegung

Komplexe Anforderungen in mehrere Teilprobleme zerlegen, die jeweils unabhängig lösbar sind

2

Schrittweise Denkweise

Für jedes Teilproblem schrittweise tiefer nachdenken und den Denkprozess festhalten

3

Hypothesen überprüfen

Jede Annahme überprüfen, um sicherzustellen, dass die Logik korrekt ist

4

Integrierte Lösung

Die Lösungen der einzelnen Teilprobleme zu einer vollständigen Lösung zusammenführen

5

Iterative Optimierung

Die Lösung auf Basis von Feedback kontinuierlich optimieren und verbessern

Praxisbeispiel: Benutzeranmeldefunktion

Denkschritt 1: Das Problem zerlegen
• Wie gibt der Benutzer Konto und Passwort ein?
• Wie überprüfen Sie die Benutzeridentität?
• Wie wird der Zustand nach einer erfolgreichen Anmeldung beibehalten?
• Wie geht man mit einem fehlgeschlagenen Login um?
Denkschritt 2: schrittweise vertiefen
• Frontend: Formularvalidierung, Fehlermeldungen, Ladezustände
• Backend: Passwortverschlüsselung, Token-Generierung, Sitzungsverwaltung
• Sicherheit: Schutz vor Brute-Force-Angriffen, CSRF-Schutz
Denkschritt 3: Integrationsplan
Lösungen aus den drei Bereichen Frontend, Backend und Sicherheit zu einem vollständigen Design der Anmeldefunktion zusammenführen

KI zur Unterstützung des strukturierten Denkens nutzen

Verwende das Sequential Thinking MCP-Tool oder eine ähnliche Denkmethodik, damit die KI dir hilft bei:

  • Komplexe Probleme zerlegen: KI hilft Ihnen, die wichtigsten Teilprobleme zu identifizieren
  • Den Denkprozess aufzeichnen: Jeder Denkschritt wird aufgezeichnet und ist nachverfolgbar
  • Validierungslogik:KI hilft Ihnen, logische Lücken zu prüfen
  • Iterative Optimierung:Den Ansatz anhand von Feedback kontinuierlich verbessern

Leitfaden zum Verfassen von PRDs

PRD (Product Requirements Document) ist eine vollständige Beschreibung der Produktanforderungen. Im Zeitalter des KI-Codings muss das PRDStrukturiert, ausführbar und für KI lesbar

Kernstruktur des PRD

1. Produktübersicht

Erforderlich

Produktpositionierung, Zielnutzer, Kernwert, Ziel in einem Satz

2. Funktionale Anforderungen

Erforderlich

Funktionsliste, User Stories, Prioritäten, Abnahmekriterien

3. Nicht-funktionale Anforderungen

Erforderlich

Anforderungen an Leistung, Sicherheit, Verfügbarkeit und Skalierbarkeit

4. Schnittstellendefinition

Erforderlich

Ein-/Ausgabe, Datenstrukturen, Fehlerbehandlung, API-Spezifikationen

5. Einschränkungen und Annahmen

Erforderlich

Technische Einschränkungen, Ressourcenbeschränkungen, Voraussetzungen, Nichtziele

6. Abnahmekriterien

Erforderlich

Funktionsabnahme, Leistungsabnahme, Sicherheitsabnahme, DoD-Checkliste

Prinzipien für KI-lesbare PRDs

❌ Vage Beschreibung
Benutzer-Login-Funktion - Benutzer können sich anmelden - Nach der Anmeldung können sie auf das System zugreifen
✅ Strukturierte Beschreibung
Benutzeranmeldefunktion Ziel: Benutzer melden sich mit Konto und Passwort im System an Eingabe: username (string), password (string) Ausgabe: token (string), userInfo (object) Fehler: 401 Passwort falsch, 429 Anfragen zu häufig Abnahme: Bei Eingabe des richtigen Passworts wird ein token zurückgegeben, bei falschem Passwort 401

Best Practices für das Erstellen von PRDs

  • Klare Ziele: Jede Funktion sollte „warum wird sie benötigt“ und „ein Satz zum Ziel“ beantworten
  • Nicht-Ziele definieren:klar angeben, was nicht getan wird, um eine Ausweitung des Umfangs zu vermeiden
  • Strukturierte Beschreibung: Markdown-Format mit klarer hierarchischer Struktur verwenden
  • Testbarkeit: Anforderungen müssen überprüfbar und testbar sein und Akzeptanzkriterien enthalten
  • Versionskontrolle: PRD sollten wie Code versioniert werden (Git)
  • Kontinuierlich aktualisiert:Bei Anforderungsänderungen die Dokumentation zeitnah aktualisieren und Dokumentation und Code synchron halten

Spec-getriebene Entwicklung

Spec-Driven Development betontZuerst die Spezifikation schreiben, dann den Code。 Spezifikationen sind Kontext und helfen der KI, Anforderungen besser zu verstehen und Code zu erzeugen, der den Erwartungen entspricht.

Traditioneller Entwicklungsprozess

1Anforderungsdiskussion
2Direktes Programmieren
3Probleme entdecken
4Nacharbeit und Änderungen

Spec-gesteuerter Ablauf

1Spec schreiben
2Überprüfung bestätigt
3Spec-basiertes Coding
4Abnahme gemäß Spec

Kernelemente der Spec

1
Ziele: Welches Problem löst diese Funktion? Was ist das Ziel in einem Satz?
2
Nichtziele:Was macht diese Funktion nicht? Die Grenzen klar definieren
3
Schnittstellendefinition: Ein-/Ausgabe, Datenstrukturen, Fehlerbehandlung, API-Spezifikationen
4
Akzeptanzkriterien (Acceptance Criteria):Was gilt als abgeschlossen? Enthält Funktionsabnahme und Leistungsabnahme

Einen Spec mit KI generieren

Lassen Sie KI aus den Anforderungen ein Spec generieren, und anschließend prüfen und optimieren Sie es:

Prompt-Beispiel:
Bitte hilf mir, ein Spec für eine Benutzer-Login-Funktion zu erstellen, einschließlich: 1. Ziele und Nicht-Ziele 2. Schnittstellendefinition (Ein-/Ausgabe, Fehlerbehandlung) 3. Abnahmekriterien 4. Technische Einschränkungen

WBS-Arbeitsstruktur

Die WBS (Work Breakdown Structure) zerlegt komplexe Projekte in überschaubare kleine Aufgaben. Im Zeitalter des KI-Programmings, Die Aufgabenteilung ermöglicht es der KI, schrittweise auszuführenum die Erfolgsquote zu erhöhen.

Zerlegungsprinzip

MECE-Prinzip
Gegenseitig ausschließend und gemeinsam erschöpfend (Mutually Exclusive, Collectively Exhaustive)
Mäßige Granularität
Jede Aufgabe kann in 1–3 Tagen erledigt werden und eignet sich für die schrittweise Ausführung durch KI
Lieferbar
Jede Aufgabe hat ein klar definiertes, überprüfbares Ergebnis
Klare Abhängigkeiten
Die Abhängigkeiten zwischen Aufgaben klären und die Ausführungsreihenfolge festlegen

Beispiel: Benutzer-Login-Funktion

WBS-Struktur:
Benutzer-Login-Funktion ├─ Frontend-Login-Seite │ ├─ Entwicklung von UI-Komponenten │ ├─ Formularvalidierung │ └─ Fehlermeldungen ├─ Backend-API-Entwicklung │ ├─ Login-Schnittstelle │ ├─ Token-Generierung │ └─ Sitzungsverwaltung └─ Tests ├─ Unit-Tests └─ Integrationstests

KI zur Unterstützung der Aufgabenzerlegung verwenden

Lass die KI das PRD in eine umsetzbare Aufgabenliste zerlegen:

Prompt-Beispiel:
Bitte zerlege das folgende PRD in eine WBS-Aufgabenliste: [PRD-Inhalt einfügen] Anforderungen: 1. Jede Aufgabe sollte einen angemessenen Umfang haben (in 1–3 Tagen erledigbar) 2. Aufgabenabhängigkeiten klar definieren 3. Für jede Aufgabe klare Abnahmekriterien festlegen

DoD Definition of Done

DoD (Definition of Done) definiert die Abnahmekriterien für den Abschluss einer Aufgabe. Im Zeitalter der KI-Programmierung,Die DoD kann automatisch überprüft werdenund stellt so eine gleichbleibende Qualität sicher.

Standard-DoD-Checkliste

Der Code hat alle Tests bestanden (Unit-Tests, Integrationstests)
Der Code hat die Codeprüfung bestanden (KI-Prüfung + menschliche Prüfung)
Die Dokumentation wurde aktualisiert (PRD, API-Dokumentation, README)
Den Coding-Standards entsprechen (ESLint, Prettier, TypeScript)
In die Testumgebung bereitgestellt und erfolgreich verifiziert
Vom Produktmanager abgenommen (Funktionen entsprechen dem PRD)

KI-automatisierte DoD-Prüfung

KI-Tools verwenden, um die DoD-Checkliste automatisch zu prüfen und die Effizienz zu steigern:

Code-Review
Verwenden Sie KI-Code-Review-Tools (z. B. Cursor, GitHub Copilot), um die Codequalität automatisch zu prüfen
Testgenerierung
Verwenden Sie KI, um Testfälle zu generieren und die Codeabdeckung sicherzustellen
Dokumentensynchronisierung
KI verwenden, um die Konsistenz zwischen Dokumentation und Code zu prüfen und die Dokumentation automatisch zu aktualisieren

Der Wert von DoD

  • Qualitätssicherung: Sicherstellen, dass alle Aufgaben einen einheitlichen Qualitätsstandard erfüllen
  • Nacharbeit reduzieren: Probleme frühzeitig erkennen und spätere Änderungen vermeiden
  • Teamkonsens: Alle haben ein einheitliches Verständnis davon, was „fertig“ bedeutet
  • Rückverfolgbarkeit: den Abschlussstatus jeder Aufgabe klar dokumentieren
  • KI-freundlich: Klare Abnahmekriterien lassen die KI wissen, wann die Aufgabe abgeschlossen ist

Dokumentation als Code

Im Zeitalter des KI-Programmierens,Dokumentation sollte wie Code verwaltet werden:Versionskontrolle, Code-Review, automatisierte Prüfungen, Continuous Integration.

Dokumentenversionierung

Dokumentation mit Git verwalten
docs/prd/
├── user-login.md
├── user-profile.md
└── README.md
  • • Dokumentationsänderungen werden per PR eingereicht, Code-Review
  • • Dokumentversionen und Codeversionen synchronisieren
  • • Klare und nachvollziehbare Änderungshistorie

Automatisierte Dokumentenprüfung

CI/CD-Integration
  • • Prüfen, ob das PRD-Format den Vorgaben entspricht
  • • Die Konsistenz von Dokumentation und Code prüfen
  • • API-Dokumentation automatisch generieren
  • • Dokumentvollständigkeit prüfen (Pflichtfelder)

Dokumentation als Kontext

Dokumente sind nicht nur Aufzeichnungen, sondern auchDie KI versteht den Kontext der Anforderungen。 Gute Dokumentation hilft der KI, Anforderungen genau zu verstehen und Code zu erzeugen, der den Erwartungen entspricht. Dokumentation und Code sollten synchron aktualisiert werden, um die Konsistenz zu wahren.

Lernergebnisse

Nach Abschluss dieses Kapitels werden Sie:

  • 1Die Kernideen der dokumentengetriebenen Entwicklung verstehen und das Konzept beherrschen, dass Dokumentation Kontext ist
  • 2Strukturierte Denkmethoden (Sequential Thinking) beherrschen und komplexe Probleme zerlegen können
  • 3Kann KI-lesbare PRD-Dokumente verfassen, die vollständige Produktanforderungen enthalten
  • 4Den Spec-gesteuerten Entwicklungsprozess beherrschen und das Konzept verstehen, dass die Spezifikation der Kontext ist
  • 5Kann eine effektive Aufgabenzerlegung (WBS) durchführen und den Projektfortschritt verwalten
  • 6Die Bedeutung von DoD verstehen und klare Akzeptanzkriterien definieren können
  • 7Verwaltungsmethoden für Document-as-Code beherrschen und einen Prozess zur Versionskontrolle von Dokumenten einrichten