Quick-Win-Dokumentation: Builder Documentation & User Manual
Zwei Dokumente mit festen Pflichtfeldern und klar getrennten Adressaten, das, was einen Assistenten von der Hobby-Lösung zum übergabefähigen Asset macht.
Tag 27, Folien 10–13; auf Folie 29 zugleich ein Modul der Kern-KI-Richtlinie
Zu jedem Quick Win gehören zwei Dokumente mit unterschiedlichen Adressaten.
Builder Documentation
Adressat: die Person, die den Assistenten warten, weiterentwickeln oder neu bauen will. Neun Pflichtfelder:
- Steckbrief: Name, Owner, Stand, Plattform
- Problem & Lösung: was der Assistent löst, welcher Zeitgewinn entsteht
- Setup-Anleitung: Schritt für Schritt zum Neuaufbau
- System Prompt: final und datiert
- Wissensdokumente: Liste, Stand, Verantwortung
- Test-Inputs & erwartete Outputs: drei Tests
- Curveball-Erfahrungen: was aus den Robustheitstests gelernt wurde
- Bekannte Grenzen: was der Assistent nicht kann
- Versionshistorie: saubere Änderungschronik
Die Curveball-Sektion ist laut Deck ausdrücklich Pflicht: „Sie macht eure Lernreise sichtbar.”
User Manual
Adressat: Kolleg:innen ohne Workshop-Hintergrund. Maximal zwei Seiten, in alltagstauglicher Sprache:
- Was kann der Assistent für dich? (ein bis zwei Sätze)
- Was kann er nicht? (ehrliche Grenzen)
- So nutzt du ihn, fünf bis sieben Schritte
- Drei Beispiele: was reinkommt, was rauskommt
- Häufige Fehler und wie du sie vermeidest
- Wer hilft dir? Konkrete Personen mit Kontakt
Goldene Regel laut Deck: „Wenn jemand das User Manual liest und nicht sofort weiß, wie’s geht, ist es noch nicht fertig.”
Peer-Testing in fünf Schritten
Geprüft wird die Dokumentation nicht vom eigenen Team, sondern kalt von einem Team aus einer anderen Use-Case-Familie, ohne Vorgespräch:
- Team B liest nur das User Manual und versucht eine Aufgabe blind, wo bleibt es hängen?
- Team B liest die Builder Documentation. Reicht sie, um den Assistenten neu zu bauen, wenn er gelöscht würde?
- Team B führt einen echten Test-Input durch, klappt’s?
- Strukturiertes Feedback in drei Spalten: Was klappte · Was fehlte · Was war verwirrend.
- Übergabe an Team A.