Arbeiten mit Dokumentationen

Wie du Dokumentationen in Cursor effektiv nutzt – über Prompts, externe Quellen und internen Kontext

Warum Dokumentation wichtig ist

Dokumentation liefert aktuellen, präzisen 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 Kontext wechseln zu müssen.

Wissensstand des Modells

Große Sprachmodelle werden mit Daten bis zu einem bestimmten Zeitpunkt trainiert, dem sogenannten „Knowledge Cutoff“. Das bedeutet:

• Neuere Updates von Bibliotheken sind eventuell nicht enthalten
• Neue Frameworks oder Tools sind möglicherweise unbekannt
• API-Änderungen nach dem Cutoff-Datum werden nicht erfasst
• Best Practices haben sich seit dem Training vielleicht weiterentwickelt

Wenn zum Beispiel der Knowledge Cutoff eines Modells Anfang 2024 liegt, kennt es keine Features, die Ende 2024 veröffentlicht wurden – selbst bei beliebten Frameworks.

Welches Tool sollte ich verwenden?

Benutz diesen Entscheidungsbaum, um schnell den besten Ansatz für deine Doku-Anforderungen zu bestimmen:

Mentales Modell

Tool	Mentales Modell
@Docs	Wie beim Durchstöbern und Lesen offizieller Doku
@Web	Wie beim Suchen nach Lösungen im Internet
MCP	Wie beim Zugriff auf deine interne Doku

Öffentliche Dokumentation

Externe Dokumentation umfasst öffentlich zugängliche Informationen, über die Modelle möglicherweise nur begrenzt oder veraltet informiert sind. Cursor bietet zwei Hauptmöglichkeiten, auf diese Informationen zuzugreifen.

Verwendung von @Docs

@Docs verbindet Cursor mit der offiziellen Dokumentation beliebter Tools und Frameworks. Nutze es, wenn du aktuelle, verlässliche Informationen brauchst zu:

• API-Referenzen: Funktionssignaturen, Parameter, Rückgabetypen
• Einstiegsanleitungen: Setup, Konfiguration, grundlegende Nutzung
• Best Practices: Empfohlene Patterns aus der Quelle
• Framework-spezifischem Debugging: Offizielle Troubleshooting-Anleitungen

@

@Docs Next.js How do I set up dynamic routing with catch-all routes?

∞

Agent⌘I

Auto

↑

@Web verwenden

@Web durchsucht das Internet in Echtzeit nach aktuellen Informationen, Blogposts und Community-Diskussionen. Nutz es, wenn du Folgendes brauchst:

• Aktuelle Tutorials: Community-Inhalte und Beispiele
• Vergleiche: Artikel, die unterschiedliche Ansätze gegenüberstellen
• Neueste Updates: Ganz frische 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 speziell für deine Organisation sind und die KI-Modelle während des Trainings nie gesehen haben. Das kann Folgendes sein:

• Interne APIs: Custom Services und Microservices
• Unternehmensstandards: Coding Conventions, Architektur-Patterns
• Proprietäre Systeme: Custom-Tools, Datenbanken, Workflows
• Domänenwissen: Business-Logik, Compliance-Anforderungen

Zugriff auf interne Dokus mit MCP

Das Model Context Protocol (MCP) bietet eine standardisierte Möglichkeit, deine privaten Dokus und Systeme in Cursor einzubinden. MCP wirkt als dünne Schicht zwischen Cursor und deinen internen Ressourcen.

Warum MCP wichtig ist:

• Modelle können eure internen Konventionen nicht erraten
• API-Dokumentation für Custom-Services ist nicht öffentlich verfügbar
• Business-Logik und Domänenwissen sind spezifisch für eure Organisation
• Compliance- und Sicherheitsanforderungen variieren je nach Unternehmen

Häufige MCP-Integrationen

Integration	Zugriff	Beispiele
Confluence	Confluence-Spaces des Unternehmens	Architektur-Dokumentation, API-Spezifikationen für interne Services, Coding-Standards und Guidelines, Prozessdokumentation
Google Drive	Geteilte Dokumente und Ordner	Spezifikationsdokumente, Meeting-Notizen und Entscheidungsprotokolle, Design-Dokumente und Anforderungen, Team-Wissensbasen
Notion	Workspace-Datenbanken und -Seiten	Projektdokumentation, Team-Wikis, Wissensbasen, Produktanforderungen, technische Spezifikationen
Custom	Interne Systeme und Datenbanken	Proprietäre APIs, Legacy-Dokumentationssysteme, Custom-Wissensbasen, spezialisierte Tools und Workflows

Custom-Lösungen

Für spezielle Anforderungen kannst du eigene MCP-Server bauen, die:

• interne Websites oder Portale scrapen
• sich mit proprietären Datenbanken verbinden
• auf Custom-Dokumentationssysteme zugreifen
• aus internen Wikis oder Wissensbasen ziehen

Wenn du einen Custom-MCP-Server baust, kannst du auch Tools bereitstellen, mit denen Cursor die Dokumentation aktualisieren kann

Beispiel für einen Custom-MCP-Server zum Scrapen interner Dokus:

TypeScript

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);

Doku aktuell halten

Dokumentation wird schnell veraltet. Cursor hilft dir, aktuelle und nützliche Doku zu pflegen, indem es sie auf Basis deines tatsächlichen Codes und deiner Entwicklungsgespräche generiert und aktualisiert.

Aus bestehendem Code

Verwende Cursor, um Dokumentation direkt aus deiner Codebasis zu erstellen:

API-Dokumentation

@

Generiere API-Dokumentation für diesen Express-Router, einschließlich aller Endpunkte, Parameter und Antwortformate

∞

Agent⌘I

Auto

↑

Aus Chat-Sessions

Deine Unterhaltungen mit Cursor enthalten wertvolle Intentionen, die in Dokumentation verwandelt werden können.

Problem Solving

Nach dem Lösen eines komplexen Problems:

@

Fass unsere Unterhaltung über das Einrichten der Authentifizierung als 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 Doku und @Web für Community-Wissen
• MCP schlägt die Brücke zwischen Cursor und deinen internen Systemen
• Generiere Doku aus Code und Unterhaltungen, damit Wissen stets aktuell bleibt
• Kombiniere externe und interne Doku-Quellen für ein umfassendes Verständnis