Docs/Guides/Documentation du projet

Guide : Documentation du projet

Nexora peut exploiter la documentation de votre projet — README, commentaires, fichiers de configuration — pour fournir des suggestions contextuellement cohérentes avec votre architecture et vos conventions.

ℹ️Cette fonctionnalité est disponible sur tous les plans. Plus votre documentation est structurée, plus les suggestions seront précises.

Comment Nexora analyse votre projet

À l'ouverture d'un workspace, Nexora indexe les fichiers de documentation détectés automatiquement. Cet index est transmis comme contexte système aux modèles IA, ce qui leur permet de comprendre votre projet avant même que vous posiez une question.

📄

README.md

Description du projet, instructions d'installation, architecture générale.

⚙️

Fichiers de config

package.json, tsconfig.json, pyproject.toml — pour comprendre les dépendances et les conventions.

💬

Commentaires JSDoc / docstrings

Nexora lit les annotations de types et descriptions de fonctions pour enrichir le contexte.

📁

AGENTS.md / CLAUDE.md

Si présents, ces fichiers sont prioritaires et guidé l'IA sur vos instructions spécifiques.

Configurer la documentation dans VS Code

Vous pouvez spécifier quels fichiers Nexora doit analyser via les paramètres de l'extension :

{
  "nexora.context.includeReadme": true,
  "nexora.context.includePackageJson": true,
  "nexora.context.extraFiles": [
    "ARCHITECTURE.md",
    "docs/conventions.md",
    "docs/api-reference.md"
  ],
  "nexora.context.maxFileSize": 50000
}

💡Gardez maxFileSize sous 50 000 caractères par fichier. Les fichiers plus volumineux sont tronqués automatiquement, ce qui peut exclure des informations importantes.

Structure de projet recommandée

Pour maximiser la pertinence des suggestions, adoptez cette structure documentaire :

mon-projet/

├── README.md ← Vue d'ensemble, stack, démarrage rapide

├── ARCHITECTURE.md ← Décisions d'architecture, patterns utilisés

├── docs/

│ ├── conventions.md ← Conventions de nommage, style de code

│ ├── api-reference.md ← Endpoints, types de données

│ └── glossaire.md ← Termes métier spécifiques

├── src/

│ └── ...

└── package.json

Utiliser @doc dans le Chat

Dans le panneau Chat, vous pouvez référencer explicitement un fichier de documentation pour l'inclure dans votre question :

@doc README.mdInclut votre README comme contexte de la question

@doc ARCHITECTURE.mdInclut votre fichier d'architecture

@doc docs/conventions.mdInclut un fichier de documentation personnalisé

💡Combinez @doc et @file pour des questions très ciblées : "@doc conventions.md @file src/utils/parser.ts — est-ce que ce fichier respecte nos conventions ?"

Exemple concret

Avec un README contenant votre stack et vos conventions, Nexora adapte ses suggestions :

Sans documentation projet

"Génère une fonction pour parser un CSV"

→ Suggestion générique en JavaScript natif

Avec README indexé (stack : TypeScript + zod)

"Génère une fonction pour parser un CSV"

→ Suggestion TypeScript avec validation zod, types stricts, gestion d'erreur cohérente avec votre codebase

Fichier .nexoraignore

Pour exclure des fichiers de l'indexation (secrets, fichiers volumineux, dossiers générés) :

# .nexoraignore
node_modules/
dist/
.env*
*.min.js
coverage/
docs/internal/    # Documentation interne confidentielle

⚠️Nexora ne lit jamais les fichiers .env et .env.* par défaut, même sans .nexoraignore.

← Auto-complétion Accueil Docs →