Pourquoi la documentation est importante

La documentation fournit un contexte à jour et précis. Sans elle, les modèles s’appuient sur des données d’entraînement obsolètes ou incomplètes. La documentation aide les modèles à comprendre des éléments comme :
  • APIs et paramètres actuels
  • Bonnes pratiques
  • Conventions de l’organisation
  • Terminologie du domaine
Et bien plus encore. Lis la suite pour apprendre à utiliser la documentation directement dans Cursor, sans avoir à changer de contexte.

Date limite de connaissances du modèle

Les grands modèles de langage sont entraînés sur des données jusqu’à un moment précis, appelé « date limite de connaissances ». Ça signifie :
  • Les mises à jour récentes des bibliothèques peuvent ne pas être prises en compte
  • De nouveaux frameworks ou outils peuvent être inconnus
  • Les changements d’API postérieurs à cette date peuvent passer à côté
  • Les bonnes pratiques ont peut-être évolué depuis l’entraînement
Par exemple, si la date limite de connaissances d’un modèle est début 2024, il ne connaîtra pas les fonctionnalités sorties fin 2024, même pour des frameworks populaires.

Quel outil utiliser ?

Utilise cet arbre de décision pour déterminer rapidement la meilleure approche pour ta documentation :

Modèle mental

OutilModèle mental
@DocsComme parcourir et lire la doc officielle
@WebComme chercher des solutions sur le web
MCPComme accéder à ta doc interne

Documentation publique

La documentation externe couvre des informations publiques dont les modèles peuvent avoir une connaissance limitée ou dépassée. Cursor propose deux principales façons d’accéder à ces informations.

Utiliser @Docs

@Docs relie Cursor à la documentation officielle des outils et frameworks populaires. Utilise-le quand tu as besoin d’infos à jour et fiables sur :
  • Références d’API : signatures de fonctions, paramètres, types de retour
  • Guides de démarrage : installation, configuration, utilisation de base
  • Meilleures pratiques : recommandations officielles
  • Débogage spécifique au framework : guides de dépannage officiels
@
@Docs Next.js How do I set up dynamic routing with catch-all routes?
Agent⌘I
Auto

Utiliser @Web

@Web cherche sur le web en temps réel des infos à jour, des articles de blog et des discussions de la communauté. Utilise-le quand tu as besoin de :
  • Tutoriels récents : contenu généré par la communauté et exemples
  • Comparaisons : articles comparant différentes approches
  • Mises à jour récentes : annonces ou mises à jour toutes récentes
  • Multiples perspectives : différentes façons d’aborder les problèmes
@
@Web latest performance optimizations for React 19
Agent⌘I
Auto

Documentation interne

La documentation interne comprend des informations propres à ton organisation que les modèles d’IA n’ont jamais rencontrées pendant leur entraînement. Cela peut être :
  • APIs internes : Services et microservices personnalisés
  • Normes de l’entreprise : Conventions de codage, modèles d’architecture
  • Systèmes propriétaires : Outils, bases de données, workflows personnalisés
  • Connaissances métier : Logique métier, exigences de conformité

Accéder à la doc interne avec MCP

Le Model Context Protocol (MCP) fournit un moyen standardisé d’intégrer ta documentation et tes systèmes privés dans Cursor. MCP agit comme une couche légère entre Cursor et tes ressources internes. Pourquoi MCP compte :
  • Les modèles ne peuvent pas deviner tes conventions internes
  • La doc d’API pour des services custom n’est pas publique
  • La logique métier et la connaissance du domaine sont propres à ton orga
  • Les exigences de conformité et de sécurité varient selon les entreprises

Intégrations MCP courantes

IntégrationAccèsExemples
ConfluenceEspaces Confluence de l’entrepriseDocumentation d’architecture, spécifications d’API pour les services internes, normes et guidelines de code, documentation des processus
Google DriveDocs et dossiers partagésDocuments de spécification, notes de réunion et décisions, documents de conception et exigences, bases de connaissances d’équipe
NotionBases de données et pages de l’espace de travailDocumentation de projet, wikis d’équipe, bases de connaissances, exigences produit, spécifications techniques
CustomSystèmes et bases de données internesAPIs propriétaires, systèmes de documentation legacy, bases de connaissances personnalisées, outils et workflows spécialisés

Solutions custom

Pour des besoins spécifiques, tu peux créer des serveurs MCP custom qui :
  • Scrappent des sites web ou des portails internes
  • Se connectent à des bases de données propriétaires
  • Accèdent à des systèmes de documentation personnalisés
  • Récupèrent des contenus depuis des wikis internes ou des bases de connaissances
Si tu construis un serveur MCP custom, tu peux aussi exposer des tools pour que Cursor mette à jour la doc
Exemple de serveur MCP custom pour scraper la doc interne :
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);

Garder la doc à jour

La doc devient vite obsolète. Cursor peut t’aider à maintenir une documentation à jour et utile en la générant et en la mettant à jour à partir de ton code et de tes conversations de dev.

À partir du code existant

Utilise Cursor pour générer de la documentation directement depuis ton code :
@
Génère la documentation API pour ce routeur Express, en incluant tous les endpoints, les paramètres et les formats de réponse
Agent⌘I
Auto

À partir des sessions de chat

Tes conversations avec Cursor contiennent des intentions précieuses qui peuvent être transformées en documentation.
Après avoir résolu un problème complexe :
@
Résume notre conversation sur la mise en place de l'authentification en un guide pas à pas pour le wiki de l'équipe
Agent⌘I
Auto

Points clés

  • Utiliser la documentation comme contexte rend Cursor plus précis et à jour
  • Utilise @Docs pour la doc officielle et @Web pour le savoir de la communauté
  • MCP fait le lien entre Cursor et tes systèmes internes
  • Génère de la documentation à partir du code et des conversations pour garder les connaissances à jour
  • Combine des sources de documentation externes et internes pour une compréhension complète