• TUTORIAL
  • HOW-TO
  • REFERENZ
  • MANUELL

Diátaxis-Struktur mit deiner KI erzwingen

Verbinde diesen MCP mit deinem Agenten, damit dieser Tutorials und Referenzen nicht mehr vermischt. Er erzwingt die Aufteilung deiner Dokumentation in die vier Diátaxis-Quadranten.

Fragen Sie die KI zu dieser Seite

Kurzantwort

Wie bringe ich meine KI dazu, Diátaxis zu folgen?

Dein Agent nutzt das Tool validate_technical_writing, um zu prüfen, ob deine Inhalte zu den vier Diátaxis-Kategorien passen: Tutorials, How-to-Guides, Referenzen und Erklärungen. Er markiert Inhalte, die die Grenzen dieser Typen überschreiten, damit du die Struktur korrigieren kannst. Du erhältst eine klare Übersicht, was wohin verschoben werden muss.

Wo jedes Problem landet.

Die strukturellen Ergebnisse

Die KI kategorisiert deine Inhalte basierend auf ihrer Absicht und ihrem Zweck.

TUTORIAL

Lernorientierte Pfade

Die KI erkennt Inhalte, die für das praktische Lernen gedacht sind. Sie stellt sicher, dass diese Abschnitte auf ein erfolgreiches Ergebnis für Anfänger abzielen.

HOW-TO

Aufgabenorientierte Anleitungen

Der Agent markiert Inhalte, die als Schritt-für-Schritt-Anleitung dienen sollten. Er prüft, ob diese Abschnitte spezifische Nutzerprobleme lösen.

REFERENZ

Informationsorientierte Fakten

Die KI extrahiert technische Spezifikationen und Beschreibungen. Sie stellt sicher, dass diese sachlich bleiben, ohne unnötige Erklärungen hinzuzufügen.

MANUELL

Manuelle Korrekturen

Die KI markiert Inhalte, die gegen die Diátaxis-Regeln verstoßen. Du erhältst diese spezifischen Warnungen, um die endgültige Umstrukturierung vorzunehmen.

Der Ablauf

Was deine KI tut, sobald die Dokumentation vorliegt.

Der Agent fungiert als struktureller Auditor für deine technischen Dokumente.

  1. Absicht analysieren

    Der Agent liest deinen Rohtext, um festzustellen, ob er lehrt, anleitet oder beschreibt.

    validate_technical_writing

  2. Diátaxis-Konformität prüfen

    Er vergleicht deine Inhalte mit den vier Quadranten, um Vermischungen der Typen zu finden.

    validate_technical_writing

  3. Strukturfehler identifizieren

    Der Agent findet Stellen, an denen ein Tutorial versucht, eine Referenz zu sein, oder umgekehrt.

    validate_technical_writing

  4. Korrekturliste erstellen

    Er erstellt eine Liste spezifischer Inhaltsblöcke, die verschoben oder umgeschrieben werden müssen.

    validate_technical_writing

Probieren Sie es

Kopiere diese Vorlagen zum Start.

Nutze diese Prompts, um die strukturelle Prüfung zu beginnen.

Startpunkte

Ersetze die Dateinamen oder Repository-Pfade durch deine tatsächlichen Dokumentationsdateien.

Technical Writing Prover Connector

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

Connector-Linkhttps://edge.vinkius.com/vk_preview_OWaZOabijYQqiXzNKgOGtWneCoMKT68VO6tDqnNd/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 — Technical Writing Prover capabilities are ready to use.
Konfiguration · claude_desktop_config.jsonKopieren
{
  "mcpServers": {
    "technical-writing-prover-mcp": {
      "url": "https://edge.vinkius.com/vk_preview_OWaZOabijYQqiXzNKgOGtWneCoMKT68VO6tDqnNd/mcp"
    }
  }
}
In den Chat kopieren04

  • Prüfe diese Markdown-Datei in meinem Repo auf Diátaxis-Konformität.

  • Enthält dieses Tutorial in meinem Dokumentationsordner zu viele Referenzmaterialien?

  • Analysiere die Dokumentation in diesem GitHub-Repository und markiere Abschnitte mit gemischter Absicht.

  • Überprüfe diesen technischen Leitfaden und sag mir, ob er den Regeln des How-to-Quadranten entspricht.

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

Starten Sie hier

Verbinde den Technical Writing Prover einmalig und frag dann einfach.

Verknüpfe den MCP einfach mit deinem Client. Dein Login bleibt verschlüsselt und du kannst sofort mit der Prüfung deiner Dokumente beginnen.

Technical Writing Prover mit deiner KI verbinden

FAQ

So funktioniert die Aufgabe

  • 01

    Kann die KI die Dokumentation für mich umschreiben?

    Nein. Die KI identifiziert strukturelle Probleme und markiert, was geändert werden muss, aber das eigentliche Schreiben und Verschieben der Inhalte überlässt sie dir.

  • 02

    Wird meine bestehende Datei verändert?

    Nein. Die KI liest und analysiert deine Dateien nur, um Feedback zu geben. Sie hat keine Berechtigung, deine Dokumente zu schreiben oder zu überschreiben.

  • 03

    Funktioniert es mit jedem Dokumentationsformat?

    Es funktioniert mit gängigen textbasierten Formaten wie Markdown, die dein KI-Client lesen kann.

  • 04

    Kann es meinen Schreibstil korrigieren?

    Nein. Dieses Tool dient speziell der Durchsetzung des Diátaxis-Strukturrahmens, nicht der stilistischen oder tonalen Bearbeitung.

  • 05

    Woher weiß die KI, ob ein Abschnitt ein Tutorial ist?

    Sie nutzt das Tool validate_technical_writing, um die Absicht des Inhalts mit den spezifischen Merkmalen der Diátaxis-Quadranten abzugleichen.

  • Weitere Fragen zum Technical Writing Prover? Die Connector-Seite liefert Antworten. Alle Funktionen des Technical Writing Prover Connectors ansehen

Verbinde Technical Writing Prover mit Claude, Cursor, ChatGPT & mehr