Claude · Foto: Lachlan Hardy, CC BY 2.0
documentation-engineer
Zuletzt aktualisiert:
Typ
Subagent
Lizenz
MIT
Quelle
Anwendungsfeld
Claude Subagenten
Alle, deren Doku chronisch hinterherhinkt.
Voraussetzungen
- Bestehender Code bzw. bestehende API, zu der Dokumentation erstellt werden soll
- Teaminterner Prozess, der die Pflege der Doku bei Code-Änderungen sicherstellt
Einordnung
Leicht einsetzbar, der Nutzen hängt aber davon ab, ob die Pflege danach im Team verankert wird.
Baut komplette Doku-Systeme: API-Docs, Tutorials, Guides, die mit dem Code Schritt halten.
Für wen: Alle, deren Doku chronisch hinterherhinkt.
Im Detail
Dieser Subagent baut komplette Dokumentationssysteme auf statt einzelner Textbausteine: API-Referenzen, Tutorials, Architektur-Guides und automatisierte Doku, die mit Code-Änderungen mitwächst. Er analysiert zunächst Projektstruktur und bestehende APIs, um Lücken und veraltete Inhalte zu finden, bevor er neue Inhalte erstellt. Der Fokus liegt auf Klarheit, Auffindbarkeit und Synchronität zwischen Code und Dokumentation. Da er mit dem schnellen und günstigen Haiku-Modell läuft, eignet er sich gut für regelmäßige, umfangreiche Doku-Arbeit ohne hohe Kosten, ist aber bei sehr komplexen architektonischen Abwägungen weniger geeignet als ein leistungsfähigeres Modell. Nützlich vor allem für Teams, deren Dokumentation der Code-Entwicklung hinterherhinkt oder die von Grund auf ein Doku-System aufsetzen wollen.
Schritt für Schritt
- Bestehende Doku-Lücken oder veraltete Inhalte sowie den relevanten Code bzw. die API bereitstellen.
- Den Subagenten Struktur und Texte für API-Referenz, Tutorial oder Guide entwerfen lassen.
- Entwurf gegen den tatsächlichen Code-Stand prüfen, bevor er veröffentlicht wird.
- Zuständigkeit im Team festlegen, wer die Doku bei künftigen Code-Änderungen nachzieht.
- Struktur regelmäßig gegen den Code abgleichen, damit sie nicht erneut veraltet.
Beispiel aus der Praxis
Eine API hat seit Monaten keine aktuelle Dokumentation mehr; der Subagent bekommt die Endpunkte und vorhandenen Doku-Fragmente und liefert eine strukturierte API-Referenz samt Tutorial-Gerüst.
Praxis-Tipp
Lassen Sie ihn zum Beispiel mit ‘Erstelle eine vollständige API-Referenz für alle Endpunkte in src/api und markiere veraltete Abschnitte in der bestehenden Doku’ auf ein Projekt ansetzen.
Stolperfallen
Der Agent liefert Struktur und Text, die laufende Pflege bei jeder Code-Änderung bleibt aber Teamaufgabe – ohne festen Prozess veraltet die Doku wie zuvor.
Siehe auch
Lizenz & Quelle
- Lizenz: MIT
- Quelle: VoltAgent
Häufige Fragen.
Hält der Agent die Doku dauerhaft aktuell?
Nein, er liefert Struktur und Text, die Pflege bei jedem Code-Wechsel bleibt Teamaufgabe.
Worin unterscheidet er sich von einem Content-Writer für Marketingtexte?
Er ist auf technische Präzision und Vollständigkeit ausgelegt, nicht auf Überzeugungskraft wie ein marketingorientierter Content-Writer.
Für wen lohnt er sich besonders?
Für Teams, deren Dokumentation chronisch hinterherhinkt, weil intern keine Zeit dafür gefunden wird.
Inhalt ansehen (documentation-engineer.md)
Lade …
Erfahrungen & Kommentare.
Funktioniert der Subagent bei Ihnen? Tipps, Stolperfallen, Varianten — teilen Sie es mit der Community.
Lade Kommentare …
Passt dazu.
code-reviewer
Tiefgehendes Code-Review: Sicherheitslücken, Performance, Zuverlässigkeit, Konfigurations-Review, moderne Analyse-Tools.
debugger
Spezialist für Fehler, fehlschlagende Tests und unerwartetes Verhalten; arbeitet systematisch zur Ursache.
security-auditor
DevSecOps-Audit: Schwachstellenanalyse, Threat Modeling, OAuth2/OIDC, OWASP, Cloud-Security, Compliance.
