• HIERARCHIE
  • INHALT
  • LÜCKEN
  • MENSCH

Dokumentationsstruktur mit Ihrer KI prüfen

Verbinden Sie ReadMe mit Ihrem KI-Client, um den gesamten Dokumentationsbaum zu scannen. Sobald die Verbindung steht, kann Ihr Agent Kategorien kartieren und gezielt Seiten oder Sackgassen finden.

Fragen Sie die KI zu dieser Seite

Kurzantwort

Wie kann ich meine Dokumentationsstruktur mit KI prüfen?

Ihre KI nutzt den ReadMe MCP, um Kategorielisten und Seitenhierarchien abzurufen. Sie identifiziert Lücken, defekte Links oder veraltete Inhalte, indem sie die tatsächliche Struktur mit Ihren Anforderungen abgleicht. Sie erhalten eine klare Übersicht darüber, was existiert und was korrigiert werden muss.

Hier landen alle Ergebnisse.

Prüfungsergebnisse

Die KI ordnet ihre Erkenntnisse in diese Bereiche ein.

HIERARCHIE

Vollständige Strukturkarte

Die KI ruft alle Kategorien und benutzerdefinierten Seiten ab, um einen visuellen oder textbasierten Baum Ihrer Dokumentation zu erstellen.

INHALT

Seitenverzeichnis

Sie listet jedes einzelne Dokument innerhalb einer Kategorie auf, damit Sie genau sehen, welche Themen abgedeckt sind.

LÜCKEN

Fehlende Informationen

Die KI markiert Kategorien ohne Inhalte oder Stellen, an denen die Hierarchie unvollständig wirkt.

MENSCH

Manuelle Prüfung nötig

Die KI hebt spezifische Seiten hervor, die veraltet oder redundant wirken und von Ihnen persönlich geprüft werden sollten.

Der Ablauf

Was Ihre KI tut, wenn die Anfrage eingeht.

Die KI durchläuft Ihre ReadMe-Instanz, um ein vollständiges Bild Ihrer Dokumentation zu erstellen.

  1. Baum kartieren

    Der Agent identifiziert alle Hauptebenen und verschachtelten Kategorien in Ihrer Dokumentation.

    list_categories

  2. Kategorien prüfen

    Er analysiert spezifische Kategorien, um deren interne Organisation zu verstehen.

    get_category

  3. Eigene Seiten finden

    Die KI lokalisiert benutzerdefinierte Seiten, die außerhalb der Standard-Kategorien liegen.

    list_custom_pages

  4. Seiteninhalt prüfen

    Er ruft die Dokumente innerhalb einer Kategorie ab, um Tiefe und Relevanz zu kontrollieren.

    get_category_docs

Probieren Sie es

Kopieren Sie diese Vorlagen.

Nutzen Sie diese Prompts, um Ihre Prüfung zu starten.

Startpunkte

Passen Sie die Kategorienamen oder Seitentitel an, um die Prüfung gezielt zu steuern.

ReadMe Connector

Alles bereit. Wählen Sie Ihren MCP-Client und folgen Sie den Einrichtungsschritten.

Connector-Linkhttps://edge.vinkius.com/vk_preview_65dP2ZEWi1ggQrtmq1IKVpZ6MOAhFxi6q98C5XwC/mcp

Claude Desktop

Folgen Sie den Schritten unten, um sich in Sekunden zu verbinden.

  1. 1In Claude Desktop, open Settings → Connectors.
  2. 2Click “Add custom connector” and paste the connector link above as the remote MCP server URL.
  3. 3Click Add and start a new chat — ReadMe capabilities are ready to use.
Konfiguration · claude_desktop_config.jsonKopieren
{
  "mcpServers": {
    "readme-mcp": {
      "url": "https://edge.vinkius.com/vk_preview_65dP2ZEWi1ggQrtmq1IKVpZ6MOAhFxi6q98C5XwC/mcp"
    }
  }
}
In den Chat kopieren04

  • Liste alle Kategorien in meiner ReadMe-Dokumentation auf und zeige mir die Hierarchie.

  • Prüfe die Kategorie 'API Reference' und sag mir, ob Seiten fehlen.

  • Finde alle benutzerdefinierten Seiten in meiner Dokumentation und liste sie nach Namen auf.

  • Analysiere die Dokumente in der Kategorie 'Getting Started' und identifiziere redundante Seiten.

  • Claude
  • ChatGPT
  • Cursor
  • VS Code
  • Windsurf
  • Claude Code
  • JetBrains
  • Cline

Starten Sie hier

Einmal verbinden, dann fragen.

Verknüpfen Sie einfach Ihr ReadMe-Konto mit Vinkius. Ihre Zugangsdaten bleiben verschlüsselt, und Sie können sofort in Ihrem bevorzugten KI-Client Fragen zu Ihren Dokumenten stellen.

ReadMe mit Ihrer KI verbinden

FAQ

Verhalten der Aufgabe

  • 01

    Kann die KI meine Dokumentationsseiten bearbeiten?

    Nein. Die KI kann nur die Struktur und die Inhalte lesen. Alle Änderungen müssen Sie manuell in ReadMe vornehmen.

  • 02

    Kann die KI veraltete Inhalte für mich löschen?

    Nein. Die KI erkennt, was gelöscht werden sollte, hat aber keine Berechtigung, Seiten zu entfernen.

  • 03

    Sieht die KI meine privaten Dokumentationen?

    Ja. Die KI hat Zugriff auf alle Dokumentationen, für die Ihre ReadMe API-Zugangsdaten berechtigt sind.

  • 04

    Woran erkennt die KI, ob eine Seite veraltet ist?

    Die KI vergleicht die gelesenen Inhalte mit den Anweisungen oder Mustern, die Sie in Ihrem Prompt vorgeben.

  • 05

    Kann ich gezielt Unterkategorien prüfen?

    Ja. Sie können die KI anweisen, sich auf eine einzelne Kategorie oder einen bestimmten Satz benutzerdefinierter Seiten zu konzentrieren.

  • Weitere Fragen zu ReadMe? Alle Funktionen des ReadMe Connectors sehen

Verbinde ReadMe mit Claude, Cursor, ChatGPT & mehr