docstodev
v3.0.4
Published
Solution d’automatisation de documentation technique intelligente avec IA
Downloads
997
Maintainers
Readme
🚀 DocsToDev
L'intelligence artificielle au service de votre documentation technique.
DocsToDev est une solution d'automatisation avancée qui transforme des bases de code complexes en une documentation structurée, visuelle et compréhensible. Créé par Chadrack Massamba (EsporDev), cet outil comble le fossé entre le code brut et la connaissance métier.
✨ Fonctionnalités Clés
- 🔍 Analyse Statique Hybride : Combine l'analyse déterministe (AST) et l'IA (MakazouIA) pour interpréter le rôle métier de chaque fichier.
- 📂 Arborescence Dynamique : Génère une vue explorateur fidèle à votre structure de dossiers.
- 📊 Graphes de Dépendances : Visualisation automatique des flux et interactions via Mermaid.js.
- ⚡ Mode Incrémental : Système de cache performant pour n'analyser que les fichiers modifiés.
- 🌍 Multi-format : Export interactif en HTML, PDF, Markdown et TXT.
🛠️ Installation & Prérequis
Installation globale
npm install -g docstodev
💡 Note importante (Projets non-JS)
[!IMPORTANT] NB : Si votre projet n'est pas un projet Node.js (ex: projet HTML/CSS pur, PHP, Python, ou C#), vous devez impérativement initialiser un environnement npm à la racine de votre dossier avant de lancer l'outil :
npm init -yCela permet à DocsToDev de gérer correctement le cache et les dépendances d'analyse.
🚀 Utilisation (CLI)
Une fois installé, une seule commande suffit pour documenter tout votre projet :
npx docstodev run
Options disponibles :
| Option | Description |
| --- | --- |
| --lang <fr | en> |
| -i, --incremental | Analyse uniquement les fichiers modifiés (gain de temps). |
| --clear-cache | Vide le cache et force une analyse complète. |
| --no-animation | Désactive les animations dans le terminal (idéal pour CI/CD). |
🏗️ Architecture et Langages Supportés
DocsToDev identifie automatiquement le rôle exact de chaque fichier (Page, UI Component, API endpoint, Service, etc.).
- Web : TypeScript (
.ts,.tsx), JavaScript (.js,.jsx). - Backend : Python (
.py), Java (.java), C# (.cs), Go (.go), Rust (.rs), PHP (.php). - Design : CSS, SCSS, HTML.
👥 Bénéficiaires et Cas d'Usage
- Onboarding : Intégrez un nouveau développeur sur un projet existant en quelques minutes.
- Audit technique : Visualisez instantanément la complexité et les risques d'une base de code.
- Documentation continue : Maintenez une doc à jour à chaque commit sans effort manuel.
📄 Licence et Crédits
Développeur : Chadrack Massamba (EsporDev)
Date du projet : 6 janvier 2026
Contact : [email protected]
