Kern-Review-Agent

Dokumentations-Reviewer KI Agent

Hält Ihre Docs synchron mit Ihrem Code

Veraltete Dokumentation ist schlimmer als keine Dokumentation – sie führt aktiv in die Irre. Dokumentations-Reviewer erkennt, wenn Code-Änderungen Docs falsch machen.

Was Dokumentations-Reviewer erkennt

Die stillen Bugs – Dokumentation, die lügt

Veraltete Dokumentation

Docs, die altes Verhalten beschreiben – die gefährlichste Art von Dokumentation

Veraltete READMEAlte API-BeispieleDokumentierte veraltete Parameter

Fehlende API-Docs

Öffentliche Funktionen und Endpunkte ohne ordnungsgemäße Dokumentation

Undokumentierte ExporteFehlende Parameter-BeschreibungenKeine Rückgabetyp-Docs

Irreführende Kommentare

Kommentare, die etwas anderes sagen als der Code tut – schlimmer als keine Kommentare

Veraltete TODOsFalsche ErklärungenCopy-Paste-Kommentare

OpenAPI/Swagger-Drift

API-Docs, die nicht mit tatsächlichen Endpunkten übereinstimmen – #1 Ursache für Integrationsfehler

Falsches Response-SchemaFehlende EndpunkteVeraltete Auth-Docs

Komponenten-Docs-Sync

Storybook- und Komponenten-Dokumentation, die Props-Änderungen nicht widerspiegelt

Fehlende PropsFalsche DefaultsVeraltete Beispiele

Typ-Definitions-Mismatch

TypeDoc/JSDoc-Typen, die über tatsächliche Interfaces und Signaturen lügen

Optional als required markiertFalsche GenericsFehlende Union-Types

Abgedeckte Dokumentationstypen

Jeder Ort, an dem Docs und Code auseinanderdriften können

JSDoc / TSDoc

Funktions- und Methoden-Dokumentation

README-Dateien

Projekt- und Paket-Übersichten

Inline-Kommentare

Code-Erklärungen und TODOs

API-Dokumentation

Endpunkt-Beschreibungen und Beispiele

Typ-Definitionen

Interface- und Typ-Kommentare

Changelog-Einträge

Genauigkeit der Versionshistorie

Einzigartige Metrik

Dokumentations-Schulden-Score

Wie technische Schulden sammeln sich Dokumentations-Schulden still an. Wir geben Ihrer Codebasis einen Dokumentations-Gesundheits-Score — eine einzelne Zahl, die zeigt, wie weit Ihre Docs von der Realität abgedriftet sind.

Verfolgen Sie die Dokumentations-Frische über Zeit
Identifizieren Sie Dateien, die ohne Doc-Updates geändert wurden
Priorisieren Sie, was zuerst zu beheben ist

Dokumentations-Gesundheit

73/100

README.md

Letzte Aktualisierung vor 45 Tagen, Code 12x geändert

src/api/

3 Endpunkte undokumentiert

CHANGELOG.md

Fehlende Einträge für v2.3.0, v2.3.1

src/utils/

8 exportierte Funktionen ohne JSDoc

Trend diesen Monat-5 Punkte
Framework-Bewusst

Tiefes Framework-Wissen

Nicht nur generische Doc-Prüfungen — wir verstehen die Dokumentationsmuster Ihres Frameworks

Next.js / React

  • Komponenten-Props-Dokumentation
  • Hook-Verwendungsbeispiele
  • Route-Handler-Beschreibungen
  • Middleware-Docs

NestJS / Express

  • Swagger-Decorator-Sync
  • DTO-Dokumentation
  • Controller-Methoden-Docs
  • Modul-Beschreibungen

FastAPI / Django

  • Pydantic-Model-Docstrings
  • Endpunkt-Beschreibungen
  • Response-Schemas
  • Query-Param-Docs

GraphQL

  • Schema-Beschreibungen
  • Resolver-Dokumentation
  • Typ-Definitionen
  • Mutation/Query-Docs
KI-Vorschlag

Für Funktion processPayment(amount, currency, options):

/**
 * Verarbeitet eine Zahlungstransaktion
 * @param amount - Zahlungsbetrag in Cents (Integer)
 * @param currency - ISO 4217 Währungscode
 * @param options - Verarbeitungsoptionen
 * @param options.idempotencyKey - Eindeutiger Schlüssel
 * @param options.metadata - Benutzerdefinierte Key-Value-Paare
 * @returns Promise<PaymentResult>
 * @throws PaymentError bei Ablehnung
 */
KI-Gestützt

Nicht nur Erkennung — Generierung

Wenn wir fehlende oder veraltete Dokumentation finden, melden wir es nicht nur — wir generieren die Korrektur. KI analysiert Ihre Funktionssignaturen, Rückgabetypen und Nutzungsmuster, um genaue Dokumentation vorzuschlagen.

Auto-Generate JSDoc

Erstellt Dokumentation aus Funktionssignaturen und Typen

Bestehende Docs aktualisieren

Aktualisiert veraltete Dokumentation, um mit aktuellem Code übereinzustimmen

Dokumentations-Drift erkennen

Echte Beispiele von Docs, die aktualisiert werden mussten

Veraltete Parameter-Dokumentation

Veraltet
/**
 * Ruft Benutzer nach ID ab
 * @param id - Benutzer-ID
 * @param includeDeleted - Soft-gelöschte Benutzer einschließen
 */
async function getUser(id: string, options?: GetUserOptions) {
  // includeDeleted wurde vor 3 Monaten in options-Objekt verschoben
  // aber JSDoc zeigt immer noch alte Signatur
}

JSDoc zeigt alte Signatur mit Positions-Parameter

Aktualisiert
/**
 * Ruft Benutzer nach ID ab
 * @param id - Benutzer-ID
 * @param options - Abfrageoptionen
 * @param options.includeDeleted - Soft-gelöschte Benutzer einschließen
 * @param options.fields - Auszuwählende Felder
 */
async function getUser(id: string, options?: GetUserOptions) {
  // Dokumentation entspricht tatsächlicher Signatur
}

Aktualisierung auf aktuelles Options-Objekt-Muster

Irreführender Kommentar

Veraltet
// 3x mit exponentiellem Backoff wiederholen
async function fetchWithRetry(url: string) {
  const MAX_RETRIES = 5  // Geändert von 3
  const response = await fetch(url)
  // Tatsächlich keine Retry-Logik mehr implementiert
  return response
}

Kommentar beschreibt Retry-Logik, die nicht existiert

Aktualisiert
// Einfacher Fetch-Wrapper, keine Retry-Logik
// Für Wiederholungen, verwenden Sie fetchWithRetry aus @/lib/http
async function simpleFetch(url: string) {
  const response = await fetch(url)
  return response
}

Kommentar spiegelt tatsächliches Verhalten wider

README-Drift

Veraltet
## Installation
```bash
npm install
npm run setup  # Dieses Skript wurde entfernt
```

## Umgebungsvariablen
- `DATABASE_URL` - PostgreSQL-Verbindung
- `REDIS_URL` - Redis-Verbindung  # Wir sind auf In-Memory-Cache umgestiegen

README verweist auf entferntes Skript und alte Redis-Konfiguration

Aktualisiert
## Installation
```bash
npm install
```

## Umgebungsvariablen
- `DATABASE_URL` - PostgreSQL-Verbindungsstring
- `CACHE_TTL` - Cache-Dauer in Sekunden (Standard: 3600)

Dokumentation spiegelt aktuellen Setup-Prozess wider

Semantische Analyse

Wie Dokumentations-Reviewer funktioniert

Dokumentations-Reviewer überprüft nicht nur, ob Docs existieren – er verifiziert, dass sie mit dem übereinstimmen, was der Code tatsächlich tut. Wenn Sie eine Funktionssignatur ändern, markiert er das JSDoc.

Semantischer Abgleich

Vergleicht, was Docs sagen vs. was Code tut

Änderungserkennung

Bemerkt, wenn Code-Änderungen nahegelegene Docs ungültig machen

Update-Vorschläge

Liefert spezifischen Text zur Korrektur der Dokumentation

Analyse-Pipeline

1

Code & Docs vergleichen

Prüft, ob die Dokumentation mit der tatsächlichen Implementierung übereinstimmt

2

Änderungen erkennen

Identifiziert, wenn Code-Änderungen bestehende Docs ungültig machen

3

Unstimmigkeiten markieren

Meldet Dokumentation, die Entwickler in die Irre führen könnte

4

Updates vorschlagen

Liefert spezifischen Text, um Docs auf den neuesten Stand zu bringen

Warum Dokumentations-Genauigkeit wichtig ist

Schlechte Docs kosten mehr als keine Docs

Schnelleres Debugging

Genaue Docs bedeuten, dass Entwickler keine Stunden mit falschen Fährten verschwenden

Besseres Onboarding

Neue Entwickler können dem vertrauen, was sie lesen, anstatt zu raten

API-Vertrauen

Nutzer können sich auf Ihre API-Docs verlassen, ohne Trial-and-Error

Jede Code-Änderung ist eine Chance für Docs, abzudriften.
Dokumentations-Reviewer erkennt es jedes Mal.

Dokumentations-Schulden sind überall

Diese Probleme rutschen jeden Tag durch — bis jetzt

65%

der README-Dateien sind innerhalb von 6 Monaten veraltet

40%

der JSDoc-Kommentare stimmen nicht mit Funktionssignaturen überein

3,2h

durchschnittlich verschwendete Zeit beim Debugging wegen falscher Docs

80%

der API-Docs fehlt mindestens ein erforderliches Feld

Halten Sie Docs und Code
synchron

Lassen Sie Dokumentations-Reviewer Drift erkennen, bevor es irreführt. 14 Tage kostenlos, keine Kreditkarte erforderlich.

JSDoc-Validierung
README-Synchronisierung
Kommentar-Genauigkeit