Zum Inhalt springen

KI-Dokumentation

Dokumentation für Dateien, Module und ganze Projekte automatisch generieren. Mermaid-Architekturdiagramme, Changelogs aus der Git-History und JSDoc/TSDoc-Kommentare.

📝

Datei-Docs

`/docs <Datei>` für jede Quelldatei.

📂

Modul-Docs

`/docs <Modul>` für ganze Module.

🎨

Mermaid-Diagramme

`/mermaid` generiert Architekturdiagramme.

📋

Changelog

`/changelog` aus der Git-History.

📊

Session-Reports

`/report` mit Token- und Kosten-Analytics.

🤖

Doc-Writer-Agent

Dedizierter Agent für umfassende Docs.

Was dokumentiert wird

Von einzelnen Funktionen bis zu ganzen Projektarchitekturen — die KI schreibt Dokumentation auf jedem Abstraktionsniveau.

📝

Funktionen & Methoden

JSDoc / TSDoc / Docstrings für jede exportierte Funktion — Parameter, Rückgabetypen und Verwendungsbeispiele.

📂

Module & Dateien

README.md-Dateien auf Modulebene, die Zweck, Exports und Verwendung erklären.

🏗️

Projektarchitektur

High-Level-Architekturguide: Datenfluss, Service-Interaktionen, wichtige Design-Entscheidungen.

🖼️

Diagramme

Mermaid-Diagramme für Datenbankschema, Auth-Flows, API-Routen und Service-Abhängigkeiten.

Mermaid-Diagramme

Visuelle Diagramme direkt aus der Codebase generieren. Die KI analysiert Struktur und Beziehungen und gibt Mermaid-Syntax aus.

/mermaidÜbersicht der Projektarchitektur
/mermaid database schemaER-Diagramm aus Datenbankmodellen
/mermaid auth flowSequenzdiagramm für Authentifizierung
/mermaid api routesFlowchart aller API-Endpunkte

# Beispiel Mermaid Output

graph TD
  A[Client] --> B[API Gateway]
  B --> C[Auth Service]
  B --> D[User Service]
  C --> E[(Database)]
  D --> E

Changelog-Generierung

/changelog ausführen, um einen CHANGELOG.md-Eintrag im Keep-a-Changelog-Format aus der Git-History seit dem letzten Tag zu generieren.

CHANGELOG.md
## [1.3.0] - 2025-07-21

### Hinzugefügt
- KI-gestütztes Security Scanning mit SARIF-Ausgabe

### Geändert
- Verbesserte False-Positive-Erkennung im Code Review

### Behoben
- Auth-Token-Refresh bei Session-Ablauf

Dokumentation automatisieren

Lass die KI Docs schreiben und pflegen während du weiterentwickelst.

Jetzt starten