[Cursor-Guide]Arbeiten mit Dokumentation

Original-Link: Original-Link

Wie Sie Dokumentation in Cursor effektiv nutzen können, durch Prompting, externe Quellen und internen Kontext

Warum Dokumentation wichtig ist

Dokumentation liefert aktuellen, präzisen Kontext. Ohne sie verwenden Modelle veraltete oder unvollständige Trainingsdaten. Dokumentation hilft Modellen, folgende Aspekte zu verstehen:

• Aktuelle APIs und Parameter
• Best Practices
• Organisationsspezifische Konventionen
• Fachterminologie

Und vieles mehr. Lesen Sie weiter, um zu erfahren, wie Sie Dokumentation direkt in Cursor nutzen können, ohne den Kontext wechseln zu müssen.

Wissensstand des Modells

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

• Aktuelle Bibliotheks-Updates sind möglicherweise nicht berücksichtigt
• Neue Frameworks oder Tools könnten unbekannt sein
• API-Änderungen nach dem Wissensstand werden nicht erfasst
• Best Practices haben sich seit dem Training möglicherweise weiterentwickelt

Beispielsweise wird ein Modell mit einem Wissensstand von Anfang 2024 keine Features kennen, die Ende 2024 veröffentlicht wurden, selbst bei beliebten Frameworks.

Welches Tool sollte ich verwenden?

Nutzen Sie diese Entscheidungshilfe, um das passende Tool auszuwählen

Mentales Modell

Öffentliche Dokumentation

Externe Dokumentation umfasst öffentlich verfügbare Informationen, über die Modelle nur begrenzt oder veraltetes Wissen haben. Cursor bietet zwei primäre Möglichkeiten, auf diese Informationen zuzugreifen.

Verwendung von @Docs

@Docs verbindet Cursor mit offizieller 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 Nutzung
• Best Practices : Empfohlene Muster aus erster Hand
• Framework-spezifisches Debugging : Offizielle Troubleshooting-Guides

Verwendung von @Web

@Web durchsucht das aktuelle Internet nach Informationen, Blogposts und Community-Diskussionen. Verwenden Sie es, wenn Sie benötigen:

• Aktuelle Tutorials : Community-generierte Inhalte und Beispiele
• Vergleiche : Artikel, die verschiedene Ansätze vergleichen
• Aktuelle Updates : Sehr frische Updates oder Ankündigungen
• Mehrere Perspektiven : Unterschiedliche Lösungsansätze

Interne Dokumentation

Interne Dokumentation umfasst organisationsspezifische Informationen, die KI-Modelle während des Trainings nie gesehen haben. Dazu gehören:

• Interne APIs : Eigene Services und Microservices
• Unternehmensstandards : Coding-Konventionen, Architekturmuster
• Proprietäre Systeme : Eigene Tools, Datenbanken, Workflows
• Fachwissen : Geschäftslogik, Compliance-Anforderungen

Zugriff auf interne Dokumente mit MCP

Das 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 eigene Services ist nicht öffentlich verfügbar
• Geschäftslogik und Fachwissen sind einzigartig für Ihre Organisation
• Compliance- und Sicherheitsanforderungen variieren je Unternehmen

Häufige MCP-Integrationen

Individuelle Lösungen

Für besondere Anforderungen können Sie eigene MCP-Server erstellen, die:

• Interne Websites oder Portals scrapen
• Mit proprietären Datenbanken verbinden
• Auf eigene Dokumentationssysteme zugreifen
• Daten aus internen Wikis oder Wissensdatenbanken beziehen

Wenn Sie einen eigenen 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 Scrapen interner Dokumente:

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

Dokumentation aktuell halten

Dokumentation veraltet schnell. Cursor kann Ihnen helfen, aktuelle, nützliche Dokumentation zu pflegen, indem es diese auf Basis Ihres Codes und Ihrer Entwicklungsgespräche generiert und aktualisiert.

Aus bestehendem Code

Nutzen Sie Cursor, um Dokumentation direkt aus Ihrem Codebase zu erstellen:

• API-Dokumentation

Generieren Sie API-Dokumentation für diesen Express-Router, inklusive aller Endpunkte, Parameter und Antwortformate

• JSDoc-Kommentare

Fügen Sie umfassende JSDoc-Kommentare zu dieser Klasse hinzu, die alle Methoden und ihre Parameter dokumentieren

• README-Erstellung

Erstellen Sie eine README für dieses Projekt mit Setup-Anleitungen, Nutzungsbeispielen und API-Überblick

Aus Chat-Sitzungen

Ihre Gespräche mit Cursor enthalten wertvolle Absichten, die in Dokumentation umgewandelt werden können.

• Problembehandlung

Fassen Sie unser Gespräch über die Einrichtung von Authentifizierung in eine Schritt-für-Schritt-Anleitung für das Team-Wiki zusammen

• Architektur

Erstellen Sie eine Dokumentation, die erklärt, warum wir dieses Datenbankdesign gewählt haben, einschließlich der Abwägungen, die wir diskutiert haben

• Debugging

Schreiben Sie eine Anleitung zur Fehlerbehebung basierend auf diesem kürzlich behobenen Fehler, einschließlich Symptomen und Lösungssschritten

Wichtige Punkte

• Dokumentation als Kontext macht Cursor präziser 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 Konversationen, um Wissen aktuell zu halten
• Kombinieren Sie externe und interne Dokumentationsquellen für ein umfassendes Verständnis

Artikelreihenindex

• [Cursor-Guide]Arbeiten mit Kontext
• [Cursor-Guide]Modelle auswählen
• [Cursor-Guide]Web-Entwicklung
• [Cursor-Guide]Architekturdiagramme
• [Cursor-Guide]Große Codebases
• [Cursor-Guide]Arbeiten mit Dokumentation