Workshops: Agentic-Engineering-Praxis
Docs-as-Code mit KI-Agenten: Workshop für Software-Dokumentation
Dokumentation fehlt oder ist veraltet, weil Schreiben mit dem Ausliefern von Features konkurriert. Coding-Agenten verschieben diese Rechnung: Sie lesen den Code, entwerfen den Text und aktualisieren die Doku im selben Pull Request wie die Änderung. In diesem halbtägigen Workshop lernen Entwickler und technische Redakteurinnen, READMEs, API-Referenzen und Anleitungen mit Claude Code, OpenAI Codex, Cursor oder GitHub Copilot zu erstellen und einen Docs-as-Code-Ablauf aufzusetzen, der sie korrekt hält.
Für wen ist der Workshop?
- Entwicklerinnen und Entwickler, die eigene Services und Bibliotheken dokumentieren
- Technische Redakteure, die mit Entwicklungsteams arbeiten
- Verantwortliche für interne Plattformen, SDKs oder Open-Source-Projekte
- Teamleitungen, die Doku und Code endlich wieder im Einklang sehen wollen
- Produktteams mit eigenem Developer-Portal
Das nehmen Sie mit
- Sie erstellen für ein bestehendes Repository ein brauchbares README samt Einstiegsanleitung und prüfen es, indem Sie es Schritt für Schritt befolgen.
- Sie lassen Docstrings, OpenAPI-Beschreibungen und Referenzdoku direkt aus dem Code schreiben und verbessern.
- Sie gliedern Dokumentation nach Zweck, etwa nach der Diátaxis-Unterscheidung in Tutorials, Anleitungen, Referenz und Erklärung.
- Sie richten eine Docs-as-Code-Pipeline mit Markdown oder AsciiDoc, einem Static-Site-Generator und automatischen Prüfungen ein.
- Sie machen Doku-Updates zum Teil jedes Pull Requests, wobei der Agent Seiten markiert, die eine Codeänderung veralten lässt.
Agenda
Modul 1
Was Agenten gut dokumentieren
- README, Setup-Anleitung und Referenz: Übung an Ihrem Repository
- Docstrings, Kommentare und OpenAPI-Beschreibungen
- Wo Agenten erfinden: Optionen, Flags und Verhalten, die es nicht gibt
Modul 2
Struktur und Stil
- Dokumenttypen nach Zweck: Tutorial, Anleitung, Referenz, Erklärung
- Styleguide und Terminologieliste, an die sich der Agent hält
- Deutsche und englische Doku nebeneinander pflegen
Modul 3
Docs as Code
- Markdown oder AsciiDoc im Repository, MkDocs, Docusaurus oder Sphinx
- Automatische Prüfungen: Links, Codebeispiele, Textlinting mit Vale
- Diagramme als Code mit Mermaid oder PlantUML
Modul 4
Doku synchron halten
- Doku im selben Pull Request wie die Codeänderung
- Review-Schritt des Agenten: Welche Seiten betrifft dieser Diff?
- Changelogs und Release Notes aus Commits
Geprüft, nicht nur generiert
Ein Agent schreibt flüssige Dokumentation in kurzer Zeit, und gerade deshalb übersieht man Fehler leicht. Erfundene Konfigurationsoptionen oder veraltete Befehle schaden mehr als eine fehlende Seite. Jede Übung endet daher mit einer Prüfung: die Setup-Anleitung in einer sauberen Umgebung durchspielen, Codebeispiele ausführen, die Referenz mit der echten API abgleichen. Wir zeigen, welche dieser Prüfungen automatisch in der CI laufen können.
Warum Docs-as-Code zu Agenten passt
Liegt die Dokumentation als Text im Repository, lesen und ändern Agenten sie mit denselben Werkzeugen wie Code, und im Review stehen Code und Doku nebeneinander. Wikis und andere Systeme lassen sich ebenfalls anbinden, etwa per MCP, doch der einfachste Weg zu korrekter Doku führt meist über das Repository.
- Doku versioniert mit dem Code, den sie beschreibt
- Review im selben Pull Request
- Automatische Prüfungen vor dem Merge
- Eine Quelle für Website, Developer-Portal und den Kontext des Agenten
Gemeinsam lernen
Am meisten bringt der halbe Tag, wenn Entwickler und technische Redaktion gemeinsam teilnehmen, denn dabei klärt sich auch, wem welcher Teil der Doku gehört. Remote oder vor Ort, auf Deutsch oder Englisch, an Ihren Repositories.
Häufige Fragen
Ersetzen Agenten unsere technische Redaktion?
Nein. Agenten übernehmen Entwürfe und Routine-Updates. Die Redaktion behält Struktur, Zielgruppenorientierung, Terminologie und Qualität im Blick und gewinnt Zeit für die Doku, die echtes Urteilsvermögen braucht.
Können Agenten Code dokumentieren, den andere geschrieben haben?
Ja, dort helfen sie oft am meisten. Den Entwurf sollte trotzdem jemand prüfen, der das System kennt, denn Agenten beschreiben, was der Code tut, nicht immer, was er tun sollte.
Welche Werkzeuge und Formate behandeln Sie?
Markdown und AsciiDoc, Static-Site-Generatoren wie MkDocs, Docusaurus oder Sphinx sowie OpenAPI für API-Referenzen. Nutzen Sie Confluence oder ein anderes Wiki, besprechen wir Möglichkeiten, es anzubinden.
Workshop
Kontakt aufnehmen
Welche Dokumentation soll endlich wieder zu Ihrem Code passen?
Wählen Sie die ungefähre Teilnehmerzahl und passende Termine – wir melden uns innerhalb von 24 Stunden mit einem Vorschlag für Inhalte, Format und Ablauf.
Lieber erst sprechen?
15 Minuten, kostenlos und unverbindlich – mit unseren AI Trainern und AI Code Engineers.
Kostenloses Gespräch buchen (öffnet in neuem Tab) +49 761 519 751 50 (rund um die Uhr)Schulung/Workshop anfragen
Workshop: Docs-as-Code mit KI-Agenten: Workshop für Software-Dokumentation · Halbtags (ca. 4 Stunden)
Weitere Workshops
- Workshops: Agentic-Engineering-PraxisFramework-Upgrades & Versionswechsel mit KI-Agenten: Workshop
- Workshops: Agentic-Engineering-PraxisPerformance-Optimierung mit KI-Coding-Agenten: Workshop
- Workshops: Agentic-Engineering-PraxisAPI-First mit KI-Agenten: Workshop zu OpenAPI & GraphQL
- Workshops: Agentic-Engineering-PraxisCoding-Agenten in großen Codebasen & Monorepos: Workshop
- Workshops: Agentic-Engineering-PraxisGit-Workflows für KI-Coding-Agenten: Halbtägige Schulung
- Agentic-Coding-ToolsCursor vs. Windsurf: Welcher KI-Code-Editor passt zu Ihrem Team?
