Warum Dokumentation wichtig ist

Dokumentation liefert aktuellen, verlässlichen Kontext. Ohne sie greifen Modelle auf veraltete oder unvollständige Trainingsdaten zurück. Dokumentation hilft Modellen, Dinge wie Folgendes zu verstehen:
  • Aktuelle APIs und Parameter
  • Best Practices
  • Organisationskonventionen
  • Fachterminologie
Und vieles mehr. Lies weiter, um zu erfahren, wie du Dokumentation direkt in Cursor nutzt, ohne den Fokus wechseln zu müssen.

Wissensstichtag des Modells

Große Sprachmodelle werden auf Daten bis zu einem bestimmten Zeitpunkt trainiert, dem sogenannten „Wissensstichtag“. Das bedeutet:
  • Kürzliche Updates von Libraries sind eventuell nicht berücksichtigt
  • Neue Frameworks oder Tools könnten unbekannt sein
  • API-Änderungen nach dem Stichtag fehlen
  • Best Practices haben sich seit dem Training möglicherweise weiterentwickelt
Wenn zum Beispiel der Wissensstichtag eines Modells Anfang 2024 liegt, kennt es keine Features, die Ende 2024 veröffentlicht wurden – selbst bei beliebten Frameworks.

Welches Tool sollte ich verwenden?

Benutze diesen Entscheidungsbaum, um schnell den besten Ansatz für deine Dokumentationsbedürfnisse zu finden:

Mentales Modell

ToolMentales Modell
@DocsWie das Durchstöbern und Lesen offizieller Dokus
@WebWie nach Lösungen im Internet suchen
MCPWie auf deine interne Doku zugreifen

Öffentliche Dokumentation

Externe Dokumentation umfasst öffentlich verfügbare Informationen, zu denen Modelle womöglich nur begrenztes oder veraltetes Wissen haben. Cursor bietet zwei Hauptwege, auf diese Informationen zuzugreifen.

Verwendung von @Docs

@Docs verbindet Cursor mit der offiziellen Dokumentation beliebter Tools und Frameworks. Nutz es, wenn du aktuelle, verlässliche Informationen brauchst zu:
  • API-Referenzen: Funktionssignaturen, Parameter, Rückgabetypen
  • Einstiegshilfen: Setup, Konfiguration, grundlegende Nutzung
  • Best Practices: Empfohlene Patterns aus der Quelle
  • Framework-spezifischem Debugging: Offizielle Troubleshooting-Guides
@
@Docs Next.js How do I set up dynamic routing with catch-all routes?
Agent⌘I
Auto

Verwendung von @Web

@Web durchsucht das Live-Internet nach aktuellen Infos, Blogposts und Community-Diskussionen. Nutz es, wenn du Folgendes brauchst:
  • Aktuelle Tutorials: Community-erstellte Inhalte und Beispiele
  • Vergleiche: Artikel, die unterschiedliche Ansätze gegenüberstellen
  • Neueste Updates: Brandaktuelle Updates oder Ankündigungen
  • Mehrere Perspektiven: Verschiedene Herangehensweisen an Probleme
@
@Web latest performance optimizations for React 19
Agent⌘I
Auto

Interne Dokumentation

Interne Dokumentation umfasst Informationen, die spezifisch für deine Organisation sind und denen KI-Modelle während des Trainings nie begegnet sind. Das kann Folgendes sein:
  • Interne APIs: maßgeschneiderte Services und Microservices
  • Unternehmensstandards: Coding Conventions, Architekturpatterns
  • Proprietäre Systeme: eigene Tools, Datenbanken, Workflows
  • Domänenwissen: Business-Logik, Compliance-Anforderungen

Zugriff auf interne Doks mit MCP

Das Model Context Protocol (MCP) bietet eine standardisierte Möglichkeit, deine private Doku und Systeme in Cursor einzubinden. MCP fungiert als dünne Schicht zwischen Cursor und deinen internen Ressourcen. Warum MCP wichtig ist:
  • Modelle kennen deine internen Konventionen nicht
  • API-Dokumentationen für eigene Services sind nicht öffentlich verfügbar
  • Business-Logik und Domänenwissen sind organisationsspezifisch
  • Compliance- und Sicherheitsanforderungen unterscheiden sich je nach Unternehmen

Häufige MCP-Integrationen

IntegrationZugriffBeispiele
ConfluenceUnternehmens-Confluence-SpacesArchitekturdokumentation, API-Spezifikationen für interne Services, Coding-Standards und Guidelines, Prozessdokumentation
Google DriveGeteilte Dokumente und OrdnerSpezifikationsdokumente, Meeting-Notizen und Entscheidungsprotokolle, Designdokumente und Requirements, Team-Wissensbasen
NotionWorkspace-Datenbanken und -SeitenProjektdokumentation, Team-Wikis, Wissensbasen, Produktanforderungen, technische Spezifikationen
CustomInterne Systeme und DatenbankenProprietäre APIs, Legacy-Dokumentationssysteme, eigene Wissensbasen, spezialisierte Tools und Workflows

Custom-Lösungen

Für besondere Anforderungen kannst du eigene MCP-Server bauen, die:
  • interne Websites oder Portale scrapen
  • sich mit proprietären Datenbanken verbinden
  • auf eigene Dokumentationssysteme zugreifen
  • aus internen Wikis oder Wissensbasen ziehen
Wenn du einen eigenen MCP-Server baust, kannst du auch Tools bereitstellen, damit Cursor die Dokumentation aktualisieren kann
Beispiel für einen eigenen MCP-Server zum Scrapen interner Doks:
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";

// Create an MCP server for scraping internal docs
const server = new McpServer({
  name: "internal-docs",
  version: "1.0.0"
});

const turndownService = new TurndownService();

// Add tool to scrape internal documentation
server.tool("get_doc",
  { url: z.string() },
  async ({ url }) => {
    try {
      const response = await fetch(url);
      const html = await response.text();
      
      // Convert HTML to markdown
      const markdown = turndownService.turndown(html);
      
      return {
        content: [{ type: "text", text: markdown }]
      };
    } catch (error) {
      return {
        content: [{ type: "text", text: `Error scraping ${url}: ${error.message}` }]
      };
    }
  }
);

// Start receiving messages on stdin and sending messages on stdout
const transport = new StdioServerTransport();
await server.connect(transport);

Docs aktuell halten

Dokumentation veraltet schnell. Cursor hilft dir, deine Doku aktuell und nützlich zu halten, indem es sie auf Basis deines tatsächlichen Codes und eurer Gespräche zur Entwicklung erzeugt und aktualisiert.

Aus bestehendem Code

Nutze Cursor, um Dokumentation direkt aus deiner Codebasis zu erstellen:
@
Erzeuge eine API-Dokumentation für diesen Express-Router, inklusive aller Endpunkte, Parameter und Response-Formate
Agent⌘I
Auto

Aus Chat-Sessions

Deine Unterhaltungen mit Cursor enthalten wertvolle Absichten, die in Dokumentation verwandelt werden können.
Nach der Lösung eines komplexen Problems:
@
Fass unsere Unterhaltung über das Einrichten von Authentifizierung zu einer Schritt-für-Schritt-Anleitung fürs Team-Wiki zusammen
Agent⌘I
Auto

Takeaways

  • Dokumentation als Kontext macht Cursor präziser und aktueller
  • Nutze @Docs für offizielle Dokumentation und @Web für Community-Wissen
  • MCP schlägt die Brücke zwischen Cursor und deinen internen Systemen
  • Generiere Dokumentation aus Code und Unterhaltungen, um Wissen aktuell zu halten
  • Kombiniere externe und interne Dokumentationsquellen für ein umfassendes Verständnis