Source de vérité pour agents IA dans VS Code
Description complète
Ce projet montre comment transformer un dépôt GitHub en source de vérité pour des agents IA. L’objectif est de cadrer la lecture, d’éviter les dérives de contexte et de produire une base de travail claire, utile à la fois pour l’humain et pour l’agent.
Difficultés rencontrées
- Éviter les consignes trop générales.
- Conserver la cohérence entre fichier de skill, documentation et contenu.
- Trouver un niveau de détail utile sans surcharger l’agent.
⏱ Temps passé : 3 heures
Genese du projet
Desireux d’avoir une documentation facilement accessible et comprehensible, j’avais en tete de faire une documentation Obsidian. En parallele, j’avais besoin d’avoir un chemin de recherche d’information efficace pour mes agents IA et limiter l’utilisation de tokens a travers la lecture du code.
C’est alors que m’est venu cette idee: creer un systeme de documentation mixte, permettant une lecture facile pour l’humain, mais egalement optimise pour mes agents IA.
Approche mixte: Humain + IA
Le projet repose sur deux principes:
- Pour l’humain: Une documentation structuree dans Obsidian avec des liens bidirectionnels, facile a explorer via le graphe de connaissances.
- Pour l’agent IA: Un index clair et des fiches modules qui limitent la consommation de tokens en ciblant precisement l’information necessaire pour les systemes RAG.
C’est ainsi que le skill “Documentation Obsidian & Agent-Ready” est ne. Il impose une discipline simple: “Pas de code sans doc”.
Structure generee
A la racine de chaque projet, le skill maintient un dossier /documentation:
documentation_index.md- la carte routiere (vue d’ensemble + liens)module_A.md- role, dependances, logique techniquemodule_B.md- idem pour chaque partie du code
Chaque fichier se concentre sur une fonctionnalite specifique avec: - Introduction: le “pourquoi” du code (vulgarisation) - Dependances: ce dont ce module a besoin - Logique technique: explication des fonctions cles pour permettre a l’IA de comprendre sans relire tout le code source
Avantages pour le developpeur
- Zero effort de redaction: L’IA s’en charge au fur et a mesure
- Vitesse de recherche: Dans Obsidian, utilisez la “Graph View” pour voir les liens entre vos fichiers
- Economie de VRAM/Contexte: L’agent lit la doc au lieu de scanner tout le code source, ce qui evite les erreurs de contexte
Resultat attendu
Un systeme ou documentation et code avancent ensemble, ou l’agent IA sait ou lire, quoi modifier et quand demander confirmation.