Dokumentation und Wissensdatenbanken mit Agents
Dokumentation hinkt dem Code oft hinterher, und Agents können die Lücke schließen helfen, wenn man sie sorgfältig einsetzt. In diesem halbtägigen Workshop lernen Sie, READMEs, Architekturüberblicke und Entscheidungsprotokolle aus Ihrem Repository zu erzeugen und zu aktualisieren, sie auf Richtigkeit zu prüfen und Wissen so zu ordnen, dass Menschen und Agents es gleichermaßen finden.
Unverbindlich anfragen- Dauer
- halber Tag
- Level
- Alle Level
- Format
- Remote oder vor Ort, Deutsch oder Englisch
- Gruppengröße
- Bis zu 12 Teilnehmende pro Trainer
Für wen der Workshop ist
- Entwickler und Tech Leads, die Projektdokumentation verantworten
- Technische Redakteure, die mit Entwicklungsteams arbeiten
- Teams, die neue Mitglieder einarbeiten oder Systeme übernehmen
Was Ihr Team danach kann
- Einen ersten Entwurf für README, Architekturnotizen und Runbooks aus dem Code erzeugen
- Generierte Dokumentation gegen das tatsächliche System prüfen
- Dokumentation im Pull-Request-Ablauf aktuell halten
- Entscheidungsprotokolle schreiben, die Gründe festhalten und nicht nur Ergebnisse
- Projektwissen so strukturieren, dass es auch als Agent-Kontext taugt
Agenda
- Welche Dokumentation sich lohntEntscheiden, welche Dokumente Ihr Team tatsächlich nutzt: Onboarding, Architektur, Betrieb, Entscheidungen.
- Entwürfe aus dem CodeEinen Agent Überblicke, Modulbeschreibungen und Diagramme aus Ihrem Repository erstellen lassen.
- Richtigkeit prüfenEntwürfe auf erfundene Details und veraltete Aussagen prüfen und kennzeichnen, was verifiziert ist.
- Dokumentation im LieferflussDokumente mit jeder Änderung aktualisieren und Prüfungen ergänzen, die veraltete oder fehlende Dokumentation melden.
- EntscheidungsprotokolleKontext, Optionen und Begründung in kurzen, einheitlichen Notizen festhalten.
- Wissensdatenbank für Menschen und AgentsInhalte so ordnen und verknüpfen, dass sie leicht durchsuchbar und als Agent-Anweisungen wiederverwendbar sind.
Voraussetzungen
- Zugriff auf ein Repository mit knapper oder veralteter Dokumentation
- Vertrautheit mit Markdown oder Ihrem Dokumentationswerkzeug
- Zugang zu einem Coding Agent
Warum Workshops von apprat.io
- Geleitet von praktizierenden AI Code Engineers
- Mit Ihren Repositories oder einem Sandbox-Projekt
- KI-Tempo, menschliche Verantwortung: Review, Sicherheit und Governance inklusive
- Zertifizierte Prozesse nach ISO 9001 & ISO/IEC 27001
- Follow-up-Sprechstunde nach 30 Tagen
Unverbindlich anfragen
Erzählen Sie uns von Ihrem Team und Ihren Zielen. Sie erhalten innerhalb eines Werktags eine passende Agenda und ein Angebot – kostenlos und unverbindlich.
24/7-Telefonsupport auf Deutsch & Englisch:
+49 761 519 751 50
Häufige Fragen
Schreibt der Agent Dokumentation, der wir vertrauen können?
Erst nach Prüfung. Ein wesentlicher Teil des Workshops besteht darin, generierten Text mit der Realität abzugleichen.
Welche Dokumentationswerkzeuge unterstützen Sie?
Wir arbeiten mit den Werkzeugen Ihres Teams. Einfaches Markdown im Repository ist ein guter Ausgangspunkt.
Hilft das bei der Einarbeitung?
Ja. Gute Dokumentation und klare Struktur verkürzen die Einarbeitung für Menschen und geben Agents besseren Kontext.
Mit * markierte Felder sind Pflichtfelder.