Pourquoi la documentation compte

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, par exemple :
  • Les API et leurs paramètres actuels
  • Les bonnes pratiques
  • Les conventions de l’organisation
  • La terminologie du domaine
Et bien plus encore. Lis la suite pour découvrir comment utiliser la documentation directement dans Cursor, sans avoir à changer de contexte.

Date de coupure des 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 de coupure des connaissances ». Ça veut dire que :
  • 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 après la date de coupure passent à la trappe
  • Les bonnes pratiques ont peut-être évolué depuis l’entraînement
Par exemple, si la date de coupure des connaissances d’un modèle est début 2024, il ne saura rien des 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 obsolète. Cursor propose deux principales façons d’y accéder.

Utiliser @Docs

@Docs relie Cursor à la doc officielle des outils et frameworks populaires. Utilise-le quand t’as besoin d’infos à jour et fiables sur :
  • Références d’API : Signatures de fonctions, paramètres, types de retour
  • Guides de prise en main : Installation, configuration, usage de base
  • Bonnes pratiques : Patterns recommandés par la source
  • Débogage spécifique aux frameworks : 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 parcourt le web en temps réel pour trouver des informations à jour, des articles de blog et des discussions de la communauté. Utilise-le quand tu as besoin de :
  • Tutoriels récents : contenu et exemples issus de la communauté
  • Comparaisons : articles qui comparent différentes approches
  • Mises à jour récentes : annonces ou nouveautés toutes fraîches
  • Multiples points de vue : différentes façons d’aborder un problème
@
@Web dernières optimisations de performance pour 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 vues pendant leur entraînement. Ça peut être :
  • API internes : Services et microservices personnalisés
  • Standards de l’entreprise : Conventions de code, patterns 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) offre un moyen standardisé d’intégrer ta documentation privée et tes systèmes dans Cursor. MCP sert de fine couche 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 organisation
  • Les exigences de conformité et de sécurité varient selon les entreprises

Intégrations MCP courantes

IntégrationAccèsExemples
ConfluenceEspaces Confluence de l’entrepriseDoc d’architecture, spécifications d’API pour les services internes, standards et guidelines de code, doc de processus
Google DriveDocuments et dossiers partagésDocs de spécification, notes de réunion et décisions, docs de conception et exigences, bases de connaissances d’équipe
NotionBases de données et pages d’espace de travailDoc de projet, wikis d’équipe, bases de connaissances, exigences produit, specs techniques
CustomSystèmes et bases de données internesAPIs propriétaires, systèmes de doc hérités, bases de connaissances custom, outils et workflows spécialisés

Solutions custom

Pour des besoins spécifiques, tu peux construire des serveurs MCP custom qui :
  • Scrappent des sites web ou portails internes
  • Se connectent à des bases de données propriétaires
  • Accèdent à des systèmes de doc 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 documentation 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 développement.

À 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 informations 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 étape par étape pour le wiki de l’équipe
Agent⌘I
Auto

Points à retenir

  • Utiliser la documentation comme contexte rend Cursor plus précis et à jour
  • Utilise @Docs pour la doc officielle et @Web pour la connaissance 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 la connaissance à jour
  • Combine des sources de doc externes et internes pour une compréhension globale