​
Warum Dokumentation wichtig ist

Dokumentation bietet aktuellen, genauen Kontext. Ohne sie verwenden Modelle veraltete oder unvollständige Trainingsdaten. Dokumentation hilft Modellen dabei, Dinge zu verstehen wie:
  • Aktuelle APIs und Parameter
  • Best Practices
  • Organisationskonventionen
  • Fachterminologie
Und vieles mehr. Lesen Sie weiter, um zu erfahren, wie Sie Dokumentation direkt in Cursor verwenden können, ohne den Kontext wechseln zu müssen.

​
Wissensstichtag des Modells

Große Sprachmodelle werden mit Daten bis zu einem bestimmten Zeitpunkt trainiert, der als “Wissensstichtag” bezeichnet wird. Das bedeutet:
  • Aktuelle Bibliotheks-Updates sind möglicherweise nicht berücksichtigt
  • Neue Frameworks oder Tools sind möglicherweise unbekannt
  • API-Änderungen nach dem Stichtag werden übersehen
  • Best Practices haben sich möglicherweise seit dem Training weiterentwickelt
Wenn beispielsweise der Wissensstichtag eines Modells Anfang 2024 liegt, kennt es keine Features, die Ende 2024 veröffentlicht wurden, selbst bei beliebten Frameworks nicht.

​
Welches Tool sollte ich verwenden?

Verwenden Sie diesen Entscheidungsbaum, um schnell den besten Ansatz für Ihre Dokumentationsanforderungen zu bestimmen:

​
Mentales Modell

ToolMentales Modell
@DocsWie das Durchsuchen und Lesen offizieller Dokumentation
@WebWie die Suche nach Lösungen im Internet
MCPWie der Zugriff auf Ihre interne Dokumentation

​
Öffentliche Dokumentation

Externe Dokumentation umfasst öffentlich verfügbare Informationen, über die Modelle möglicherweise nur begrenzte oder veraltete Kenntnisse haben. Cursor bietet zwei primäre Möglichkeiten, auf diese Informationen zuzugreifen.

​
Verwendung von @Docs

@Docs verbindet Cursor mit der offiziellen Dokumentation beliebter Tools und Frameworks. Verwenden Sie es, wenn Sie aktuelle, autoritative Informationen benötigen zu:
  • API-Referenzen: Funktionssignaturen, Parameter, Rückgabetypen
  • Erste Schritte Anleitungen: Setup, Konfiguration, grundlegende Verwendung
  • Best Practices: Empfohlene Muster aus der Quelle
  • Framework-spezifisches Debugging: Offizielle Fehlerbehebungsanleitungen
@
@Docs Next.js Wie richte ich dynamisches Routing mit Catch-All-Routen ein?
∞
Agent⌘I
Auto

​
Verwendung von @Web

@Web durchsucht das Live-Internet nach aktuellen Informationen, Blog-Posts und Community-Diskussionen. Verwenden Sie es, wenn Sie Folgendes benötigen:
  • Aktuelle Tutorials: Von der Community erstellte Inhalte und Beispiele
  • Vergleiche: Artikel, die verschiedene Ansätze vergleichen
  • Aktuelle Updates: Sehr aktuelle Updates oder Ankündigungen
  • Mehrere Perspektiven: Verschiedene Lösungsansätze für Probleme
@
@Web neueste Performance-Optimierungen für React 19
∞
Agent⌘I
Auto

​
Interne Dokumentation

Interne Dokumentation umfasst Informationen, die spezifisch für Ihre Organisation sind und denen KI-Modelle während des Trainings nie begegnet sind. Dies könnte sein:
  • Interne APIs: Benutzerdefinierte Services und Microservices
  • Unternehmensstandards: Programmierkonventionen, Architekturmuster
  • Proprietäre Systeme: Benutzerdefinierte Tools, Datenbanken, Arbeitsabläufe
  • Domänenwissen: Geschäftslogik, Compliance-Anforderungen

​
Zugriff auf interne Dokumentation mit MCP

Model Context Protocol (MCP) bietet eine standardisierte Möglichkeit, Ihre private Dokumentation und Systeme in Cursor einzubinden. MCP fungiert als dünne Schicht zwischen Cursor und Ihren internen Ressourcen. Warum MCP wichtig ist:
  • Modelle können Ihre internen Konventionen nicht erraten
  • API-Dokumentation für benutzerdefinierte Services ist nicht öffentlich verfügbar
  • Geschäftslogik und Domänenwissen sind einzigartig für Ihre Organisation
  • Compliance- und Sicherheitsanforderungen variieren je nach Unternehmen

​
Häufige MCP-Integrationen

IntegrationZugriffBeispiele
ConfluenceUnternehmens-Confluence-BereicheArchitekturdokumentation, API-Spezifikationen für interne Services, Coding-Standards und Richtlinien, Prozessdokumentation
Google DriveGeteilte Dokumente und OrdnerSpezifikationsdokumente, Besprechungsnotizen und Entscheidungsaufzeichnungen, Designdokumente und Anforderungen, Team-Wissensbasen
NotionWorkspace-Datenbanken und -SeitenProjektdokumentation, Team-Wikis, Wissensbasen, Produktanforderungen, technische Spezifikationen
BenutzerdefiniertInterne Systeme und DatenbankenProprietäre APIs, Legacy-Dokumentationssysteme, benutzerdefinierte Wissensbasen, spezialisierte Tools und Workflows

​
Benutzerdefinierte Lösungen

Für einzigartige Anforderungen können Sie benutzerdefinierte MCP-Server erstellen, die:
  • Interne Websites oder Portale durchsuchen
  • Sich mit proprietären Datenbanken verbinden
  • Auf benutzerdefinierte Dokumentationssysteme zugreifen
  • Aus internen Wikis oder Wissensbasen abrufen
Wenn Sie einen benutzerdefinierten MCP-Server erstellen, können Sie auch Tools für Cursor bereitstellen, um die Dokumentation zu aktualisieren
Beispiel für einen benutzerdefinierten MCP-Server zum Durchsuchen interner Dokumentation: 
import { McpServer, ResourceTemplate } from "@modelcontextprotocol/sdk/server/mcp.js";
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
import { z } from "zod";
import TurndownService from "turndown";

// Erstelle einen MCP-Server zum Durchsuchen interner Dokumentation
const server = new McpServer({
  name: "internal-docs",
  version: "1.0.0"
});

const turndownService = new TurndownService();

// Tool zum Durchsuchen interner Dokumentation hinzufügen
server.tool("get_doc",
  { url: z.string() },
  async ({ url }) => {
    try {
      const response = await fetch(url);
      const html = await response.text();
      
      // HTML zu Markdown konvertieren
      const markdown = turndownService.turndown(html);
      
      return {
        content: [{ type: "text", text: markdown }]
      };
    } catch (error) {
      return {
        content: [{ type: "text", text: `Fehler beim Durchsuchen von ${url}: ${error.message}` }]
      };
    }
  }
);

// Beginne mit dem Empfangen von Nachrichten über stdin und dem Senden von Nachrichten über stdout
const transport = new StdioServerTransport();
await server.connect(transport);

​
Dokumentation aktuell halten

Dokumentation veraltet schnell. Cursor kann Ihnen dabei helfen, aktuelle und nützliche Dokumentation zu pflegen, indem es diese basierend auf Ihrem tatsächlichen Code und Entwicklungsgesprächen generiert und aktualisiert.

​
Aus vorhandenem Code

Verwenden Sie Cursor, um Dokumentation direkt aus Ihrer Codebasis zu erstellen:
@
Erstelle API-Dokumentation für diesen Express-Router, einschließlich aller Endpunkte, Parameter und Antwortformate
∞
Agent⌘I
Auto

​
Aus Chat-Sitzungen

Ihre Gespräche mit Cursor enthalten wertvolle Absichten, die in Dokumentation umgewandelt werden können.
Nach der Lösung eines komplexen Problems:
@
Fassen Sie unser Gespräch über die Einrichtung der Authentifizierung in einer Schritt-für-Schritt-Anleitung für das Team-Wiki zusammen
∞
Agent⌘I
Auto

​
Wichtige Erkenntnisse

  • Dokumentation als Kontext macht Cursor genauer und aktueller
  • Verwenden Sie @Docs für offizielle Dokumentation und @Web für Community-Wissen
  • MCP überbrückt die Lücke zwischen Cursor und Ihren internen Systemen
  • Generieren Sie Dokumentation aus Code und Gesprächen, um das Wissen aktuell zu halten
  • Kombinieren Sie externe und interne Dokumentationsquellen für ein umfassendes Verständnis