Dokumentation

Dokumentation veraltet schneller, als sie geschrieben wird. Die 26 Docs-Agenten in Keyvarn OS übernehmen diese Arbeit direkt in Claude Code: Sie strukturieren READMEs mit Installation, Quickstart und Konfigurationstabelle, schreiben Getting-Started-Tutorials mit nummerierten Schritten und erwarteten Ausgaben, erzeugen valide OpenAPI-3.x-Specs und halten Architekturentscheidungen als ADRs fest. Jeder Agent arbeitet nach einem festen Output-Vertrag und markiert fehlende Angaben als Annahme oder Platzhalter, statt Inhalte zu erfinden.

Der zweite Schwerpunkt ist Pflege: Der Aktualitäts-Audit gleicht dokumentiertes Verhalten gegen den tatsächlichen Code ab und liefert einen Report mit Fundort und Schweregrad je Abweichung. Link-Prüfer, Stil-Konsistenz-Prüfer und Lesbarkeits-Optimierer halten bestehende Doku sauber. Für den Betrieb schreibt der Runbook-Autor ausführbare Schrittlisten mit Erwartungswerten, Fehlerpfaden und Eskalationspfaden; der Migrationsleitfaden führt mit Vorher/Nachher-Vergleichen und prüfbaren Schritten durch Versionswechsel. Die Agenten grenzen sich sauber voneinander ab und verweisen aufeinander — du wählst die Aufgabe, die Struktur steht.

Typische Aufgaben

• Ein Repo ohne README bekommt eine strukturierte README.md mit Projektzweck, Installation, Quickstart und Konfigurationstabelle — fehlende Angaben werden als Annahme markiert.
• Nach einem großen Refactoring gleicht der Aktualitäts-Audit die Doku gegen den Code ab und listet jede Abweichung mit Fundort und Schweregrad — kritische und mittlere Befunde mit konkretem Korrekturvorschlag.
• Für den Neustart eines Dienstes nach einer Störung entsteht ein Runbook mit kopierbaren Befehlen, Erwartungswerten je Schritt und definiertem Eskalationspfad.
• Eine REST-Schnittstelle ohne Vertragsdatei erhält eine valide OpenAPI-3.x-YAML mit Schemas, Security-Schemes und Beispiel-Payloads, die Tooling wie Swagger UI verarbeiten kann.

Alle 26 Agenten in kv-docs

Jede Zeile ist eine Datei im ausgelieferten Paket — Name identisch mit dem Ordner im Download.

• kv-docs-adr-autor Erstellt Architecture-Decision-Records mit Kontext, Optionen, Entscheidung, Konsequenzen und Status.
• kv-docs-aktualitaets-audit Prüft dokumentiertes Verhalten gegen den aktuellen Code und meldet veraltete Stellen mit Fundort.
• kv-docs-api-referenz-generator Erstellt API-Referenzen mit Signaturen, Parametern, Rückgabewerten, Fehlercodes und Beispielaufrufen.
• kv-docs-architektur-dokumentation Dokumentiert Systemarchitektur mit Kontext-, Container- und Komponentensicht plus Datenflüssen.
• kv-docs-changelog-pflege Pflegt Changelogs nach Keep-a-Changelog-Konvention mit kategorisierten Änderungen je Version.
• kv-docs-code-kommentar-doku Ergänzt Docstrings und Block-Kommentare im Konventionsformat der jeweiligen Programmiersprache.
• kv-docs-contributing-guide Erstellt eine CONTRIBUTING.md mit Setup, Konventionen, Pull-Request-Ablauf und Review-Erwartungen.
• kv-docs-deprecation-doku Dokumentiert Abkündigungen mit Zeitplan, Ersatzweg und Markierungen in der bestehenden Doku.
• kv-docs-diagramm-spezifikation Erstellt Mermaid- oder PlantUML-Code für Sequenz-, Fluss- und Komponentendiagramme mit Legende.
• kv-docs-docs-as-code-pipeline Baut Docs-as-Code-Konfigurationen mit Build-Skript, CI-Schritt und Publish-Ziel.
• kv-docs-faq-kurator Kuratiert FAQs mit gruppierten Frage-Antwort-Paaren und Querverweisen auf tiefergehende Dokumente.
• kv-docs-getting-started-guide Erstellt Getting-Started-Tutorials mit nummerierten Schritten, erwarteten Ausgaben und Endergebnis.
• kv-docs-glossar-pflege Pflegt alphabetische Glossare mit präzisen Definitionen und Verwendungshinweisen für Fachbegriffe.
• kv-docs-how-to-anleitung Schreibt zielgerichtete How-To-Anleitungen mit Voraussetzungen, Schritten und Ergebnis-Check.
• kv-docs-konfigurations-referenz Erstellt Referenztabellen aller Konfigurationsparameter mit Typ, Standardwert, Pflicht und Wirkung.
• kv-docs-konzept-erklaerung Erklärt zugrundeliegende Konzepte mit Mentalmodell, Begriffen und Designgründen.
• kv-docs-lesbarkeits-optimierer Überarbeitet Doku-Texte mit kürzeren Sätzen, weniger Fachjargon und Änderungsnotizen.
• kv-docs-link-pruefer Prüft interne und externe Verweise in der Doku und liefert einen Bericht mit Korrekturvorschlägen.
• kv-docs-migrationsleitfaden Dokumentiert Upgrade-Pfade mit Vorher/Nachher-Vergleichen und Schritt-für-Schritt-Anleitung.
• kv-docs-openapi-spec-autor Schreibt valide OpenAPI-3.x-YAML mit Pfaden, Schemas, Security-Schemes und Beispiel-Payloads.
• kv-docs-readme-architekt Erstellt strukturierte README-Dateien mit Projektzweck, Installation, Quickstart und Konfiguration.
• kv-docs-release-notes-autor Schreibt lesbare Release-Texte für Endnutzer und Stakeholder mit Highlights und Upgrade-Hinweisen.
• kv-docs-runbook-autor Erstellt Runbooks für Operations-Teams mit Schrittlisten, Erwartungswerten und Eskalationspfaden.
• kv-docs-schema-doku Dokumentiert Datenmodelle mit Entitäten, Feldern, Beziehungen, Constraints und Herkunfts-Lineage.
• kv-docs-stil-konsistenz-pruefer Prüft Doku auf einheitlichen Stil, Terminologie und Tonfall und markiert Abweichungen mit Korrektur.
• kv-docs-troubleshooting-katalog Erstellt Troubleshooting-Kataloge mit Symptom, Ursache und Lösung je dokumentiertem Problem.