​
Pourquoi la documentation est importante

La documentation fournit un contexte actuel et précis. Sans elle, les modèles utilisent des données d’entraînement obsolètes ou incomplètes. La documentation aide les modèles à comprendre des éléments tels que :
  • Les API et paramètres actuels
  • Les meilleures pratiques
  • Les conventions organisationnelles
  • La terminologie du domaine
Et bien plus encore. Continuez votre lecture pour apprendre comment utiliser la documentation directement dans Cursor sans avoir à changer de contexte.

​
Limite de connaissances du modèle

Les grands modèles de langage sont entraînés sur des données jusqu’à un point spécifique dans le temps, appelé “limite de connaissances”. Cela signifie :
  • Les mises à jour récentes de bibliothèques peuvent ne pas être reflétées
  • Les nouveaux frameworks ou outils peuvent être inconnus
  • Les changements d’API après la date limite sont manqués
  • Les meilleures pratiques peuvent avoir évolué depuis l’entraînement
Par exemple, si la limite de connaissances d’un modèle est au début de 2024, il ne connaîtra pas les fonctionnalités publiées à la fin de 2024, même pour les frameworks populaires.

​
Quel outil dois-je utiliser ?

Utilisez cet arbre de décision pour déterminer rapidement la meilleure approche pour vos besoins de documentation :

​
Modèle mental

OutilModèle Mental
@DocsComme parcourir et lire la documentation officielle
@WebComme rechercher des solutions sur internet
MCPComme accéder à votre documentation interne

​
Documentation publique

La documentation externe couvre les informations publiquement disponibles sur lesquelles les modèles pourraient avoir des connaissances limitées ou obsolètes. Cursor fournit deux moyens principaux pour accéder à ces informations.

​
Utilisation de @Docs

@Docs connecte Cursor à la documentation officielle d’outils et de frameworks populaires. Utilisez-le lorsque vous avez besoin d’informations actuelles et faisant autorité sur :
  • Références d’API : Signatures de fonctions, paramètres, types de retour
  • Guides de démarrage : Configuration, installation, utilisation de base
  • Bonnes pratiques : Modèles recommandés par la source
  • Débogage spécifique aux frameworks : Guides de dépannage officiels
@
@Docs Next.js Comment configurer le routage dynamique avec des routes catch-all ?
∞
Agent⌘I
Auto

​
Utilisation de @Web

@Web recherche sur internet en temps réel des informations actuelles, des articles de blog et des discussions communautaires. Utilisez-le lorsque vous avez besoin de :
  • Tutoriels récents : Contenu et exemples générés par la communauté
  • Comparaisons : Articles comparant différentes approches
  • Mises à jour récentes : Mises à jour ou annonces très récentes
  • Perspectives multiples : Différentes approches aux problèmes
@
@Web dernières optimisations de performance pour React 19
∞
Agent⌘I
Auto

​
Documentation interne

La documentation interne comprend des informations spécifiques à votre organisation que les modèles d’IA n’ont jamais rencontrées lors de leur entraînement. Cela peut inclure :
  • APIs internes : Services personnalisés et microservices
  • Standards d’entreprise : Conventions de codage, modèles d’architecture
  • Systèmes propriétaires : Outils personnalisés, bases de données, flux de travail
  • Connaissances métier : Logique métier, exigences de conformité

​
Accéder à la documentation interne avec MCP

Model Context Protocol (MCP) fournit un moyen standardisé d’intégrer votre documentation privée et vos systèmes dans Cursor. MCP agit comme une couche mince entre Cursor et vos ressources internes. Pourquoi MCP est important :
  • Les modèles ne peuvent pas deviner vos conventions internes
  • La documentation API pour les services personnalisés n’est pas disponible publiquement
  • La logique métier et les connaissances du domaine sont uniques à votre organisation
  • Les exigences de conformité et de sécurité varient selon l’entreprise

​
Intégrations MCP courantes

IntégrationAccèsExemples
ConfluenceEspaces Confluence de l’entrepriseDocumentation d’architecture, spécifications API pour les services internes, normes et directives de codage, documentation des processus
Google DriveDocuments et dossiers partagésDocuments de spécification, notes de réunion et enregistrements de 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
PersonnaliséSystèmes internes et bases de donnéesAPIs propriétaires, systèmes de documentation hérités, bases de connaissances personnalisées, outils et flux de travail spécialisés

​
Solutions personnalisées

Pour des besoins uniques, vous pouvez créer des serveurs MCP personnalisés qui :
  • Extraient des sites web ou portails internes
  • Se connectent à des bases de données propriétaires
  • Accèdent à des systèmes de documentation personnalisés
  • Récupèrent des wikis internes ou des bases de connaissances
Si vous créez un serveur MCP personnalisé, vous pouvez également exposer des outils pour que Cursor puisse mettre à jour la documentation
Exemple de serveur MCP personnalisé pour extraire la documentation 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";

// Créer un serveur MCP pour extraire la documentation interne
const server = new McpServer({
  name: "internal-docs",
  version: "1.0.0"
});

const turndownService = new TurndownService();

// Ajouter un outil pour extraire la documentation interne
server.tool("get_doc",
  { url: z.string() },
  async ({ url }) => {
    try {
      const response = await fetch(url);
      const html = await response.text();
      
      // Convertir HTML en markdown
      const markdown = turndownService.turndown(html);
      
      return {
        content: [{ type: "text", text: markdown }]
      };
    } catch (error) {
      return {
        content: [{ type: "text", text: `Erreur lors de l'extraction de ${url}: ${error.message}` }]
      };
    }
  }
);

// Commencer à recevoir des messages sur stdin et envoyer des messages sur stdout
const transport = new StdioServerTransport();
await server.connect(transport);

​
Maintenir la documentation à jour

La documentation devient rapidement obsolète. Cursor peut vous aider à maintenir une documentation actuelle et utile en la générant et en la mettant à jour en fonction de votre code réel et de vos conversations de développement.

​
À partir du code existant

Utilisez Cursor pour créer de la documentation directement à partir de votre base de code :
@
Générer la documentation API pour ce routeur Express, incluant tous les endpoints, paramètres et formats de réponse
∞
Agent⌘I
Auto

​
À partir des sessions de chat

Vos 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ésumez notre conversation sur la configuration de l'authentification en un guide étape par étape pour le wiki de l'équipe
∞
Agent⌘I
Auto

​
Points clés

  • La documentation comme contexte rend Cursor plus précis et à jour
  • Utilisez @Docs pour la documentation officielle et @Web pour les connaissances communautaires
  • MCP fait le pont entre Cursor et vos systèmes internes
  • Générez de la documentation à partir du code et des conversations pour maintenir les connaissances à jour
  • Combinez les sources de documentation externes et internes pour une compréhension complète