# 📑 Index Documentation Endobest Dashboard **Guide de Navigation Complet** --- ## 🎯 Par Niveau de Compréhension ### 👤 Utilisateurs Finaux (Non-Techniques) **Commencez par:** 1. [DOCUMENTATION_32_QUICK_START.md](DOCUMENTATION_32_QUICK_START.md) - 5 minutes pour démarrer 2. [DOCUMENTATION_98_USER_GUIDE.md](DOCUMENTATION_98_USER_GUIDE.md) - FAQ et troubleshooting **Besoin de modifier les rapports?** - [DOCUMENTATION_99_CONFIG_GUIDE.md](DOCUMENTATION_99_CONFIG_GUIDE.md) - Configuration Excel simple --- ### 👨‍💼 Administrateurs Système **À lire obligatoirement:** 1. [DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md](DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md) - Vue globale (30 min) 2. [DOCUMENTATION_99_CONFIG_GUIDE.md](DOCUMENTATION_99_CONFIG_GUIDE.md) - Gestion configuration 3. [DOCUMENTATION_98_USER_GUIDE.md](DOCUMENTATION_98_USER_GUIDE.md) - Support utilisateurs **Cas avancés:** - [DOCUMENTATION_12_QUALITY_CHECKS.md](DOCUMENTATION_12_QUALITY_CHECKS.md) - Règles validation - [DOCUMENTATION_13_EXCEL_EXPORT.md](DOCUMENTATION_13_EXCEL_EXPORT.md) - Export personnalisé --- ### 👨‍💻 Développeurs **Fondamentaux:** 1. [DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md](DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md) - Architecture complète 2. [DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md](DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md) - Flux d'exécution avec diagrammes 3. [DOCUMENTATION_10_ARCHITECTURE.md](DOCUMENTATION_10_ARCHITECTURE.md) - Détails techniques approfondis **Implémentation:** - [DOCUMENTATION_11_FIELD_MAPPING.md](DOCUMENTATION_11_FIELD_MAPPING.md) - Extraction et transformation - [DOCUMENTATION_12_QUALITY_CHECKS.md](DOCUMENTATION_12_QUALITY_CHECKS.md) - Validation de qualité - [DOCUMENTATION_13_EXCEL_EXPORT.md](DOCUMENTATION_13_EXCEL_EXPORT.md) - Module Excel export **Code:** - `eb_dashboard.py` (57.5 KB) - Orchestrateur principal - `eb_dashboard_utils.py` (6.4 KB) - Utilitaires - `eb_dashboard_quality_checks.py` (58.5 KB) - Validation - `eb_dashboard_excel_export.py` (32 KB) - Export Excel --- ## 📚 Par Sujet ### 🔐 Authentification & Sécurité - [DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md#api-integration](DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md#-api-integration) - [DOCUMENTATION_10_ARCHITECTURE.md#api-integration](DOCUMENTATION_10_ARCHITECTURE.md#api-integration) ### 🔄 Flux de Données - [DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md#1️⃣-main-execution-flow](DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md#1️⃣-main-execution-flow) - [DOCUMENTATION_10_ARCHITECTURE.md#complete-data-collection-workflow](DOCUMENTATION_10_ARCHITECTURE.md#complete-data-collection-workflow) ### ⚡ Performance & Optimisations - [DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md#multithreading--performance-optimization](DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md#⚡-multithreading--performance-optimization) - [DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md#5️⃣-multithreading-architecture](DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md#5️⃣-multithreading-architecture) - [DOCUMENTATION_10_ARCHITECTURE.md#multithreading--performance](DOCUMENTATION_10_ARCHITECTURE.md#multithreading--performance) ### 📊 Extraction & Traitement des Champs - [DOCUMENTATION_11_FIELD_MAPPING.md](DOCUMENTATION_11_FIELD_MAPPING.md) - **Guide complet** - [DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md#field-extraction--processing-logic](DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md#🔍-field-extraction--processing-logic) - [DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md#3️⃣-field-processing-pipeline](DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md#3️⃣-field-processing-pipeline) ### ✅ Validation & Contrôles Qualité - [DOCUMENTATION_12_QUALITY_CHECKS.md](DOCUMENTATION_12_QUALITY_CHECKS.md) - **Guide complet** - [DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md#quality-assurance-framework](DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md#✅-quality-assurance-framework) - [DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md#6️⃣-quality-checks-logic](DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md#6️⃣-quality-checks-logic) ### 📋 Configuration Excel - [DOCUMENTATION_99_CONFIG_GUIDE.md](DOCUMENTATION_99_CONFIG_GUIDE.md) - **Référence complète** - [DOCUMENTATION_32_QUICK_START.md#configuration-excel](DOCUMENTATION_32_QUICK_START.md#-configuration-excel) ### 📈 Export Excel - [DOCUMENTATION_13_EXCEL_EXPORT.md](DOCUMENTATION_13_EXCEL_EXPORT.md) - **Guide complet** - [DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md#7️⃣-excel-export-pipeline](DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md#7️⃣-excel-export-pipeline) ### 🛡️ Gestion d'Erreurs & Résilience - [DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md#error-handling--resilience](DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md#🛡️-error-handling--resilience) - [DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md#8️⃣-error-handling--recovery](DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md#8️⃣-error-handling--recovery) - [DOCUMENTATION_10_ARCHITECTURE.md#error-handling--resilience](DOCUMENTATION_10_ARCHITECTURE.md#error-handling--resilience) ### 🧵 Multithreading - [DOCUMENTATION_10_ARCHITECTURE.md#multithreading--performance](DOCUMENTATION_10_ARCHITECTURE.md#multithreading--performance) - [DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md#thread-pool-architecture](DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md#thread-pool-architecture) - [DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md#5️⃣-multithreading-architecture](DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md#5️⃣-multithreading-architecture) ### 🎯 Modes d'Exécution - [DOCUMENTATION_32_QUICK_START.md#three-simple-ways-to-run](DOCUMENTATION_32_QUICK_START.md#three-simple-ways-to-run) - [DOCUMENTATION_10_ARCHITECTURE.md#execution-modes](DOCUMENTATION_10_ARCHITECTURE.md#execution-modes) - [DOCUMENTATION_98_USER_GUIDE.md#what-happens-when-you-run-the-script](DOCUMENTATION_98_USER_GUIDE.md#what-happens-when-you-run-the-script) ### 📁 Structure des Fichiers de Sortie - [DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md#json-output-structure](DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md#json-output-structure) - [DOCUMENTATION_10_ARCHITECTURE.md#expected-output-structure](DOCUMENTATION_10_ARCHITECTURE.md#expected-output-structure) - [DOCUMENTATION_32_QUICK_START.md#what-gets-created](DOCUMENTATION_32_QUICK_START.md#-what-gets-created) --- ## 🔍 Par Cas d'Usage ### "Je veux juste exécuter le script" → [DOCUMENTATION_32_QUICK_START.md](DOCUMENTATION_32_QUICK_START.md) ### "Je dois ajouter un nouveau champ au rapport" → [DOCUMENTATION_11_FIELD_MAPPING.md](DOCUMENTATION_11_FIELD_MAPPING.md) ### "Je dois modifier les règles de validation" → [DOCUMENTATION_12_QUALITY_CHECKS.md](DOCUMENTATION_12_QUALITY_CHECKS.md) ### "Je dois créer un nouveau rapport Excel" → [DOCUMENTATION_13_EXCEL_EXPORT.md](DOCUMENTATION_13_EXCEL_EXPORT.md) ### "Je dois comprendre comment ça marche" → [DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md](DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md) + [DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md](DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md) ### "Quelque chose ne marche pas" → [DOCUMENTATION_98_USER_GUIDE.md#troubleshooting](DOCUMENTATION_98_USER_GUIDE.md#troubleshooting) ### "Comment est-ce sécurisé?" → [DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md#token-management-strategy](DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md#token-management-strategy) ### "C'est trop lent" → [DOCUMENTATION_10_ARCHITECTURE.md#performance-metrics--benchmarks](DOCUMENTATION_10_ARCHITECTURE.md#performance-metrics--benchmarks) ### "Je dois enrichir les organisations avec des centres" → [DOCUMENTATION_10_ARCHITECTURE.md#organization--center-mapping](DOCUMENTATION_10_ARCHITECTURE.md#organization--center-mapping) ### "Je veux automatiser la collecte" → [DOCUMENTATION_98_USER_GUIDE.md#common-tasks](DOCUMENTATION_98_USER_GUIDE.md#common-tasks) --- ## 📊 Documents Synthétiques ### 📋 Résumés | Document | Durée | Contenu | |----------|-------|---------| | [DOCUMENTATION_32_QUICK_START.md](DOCUMENTATION_32_QUICK_START.md) | 5 min | Démarrage rapide | | [DOCUMENTATION_36_GUIDE_FRANCAIS.md](DOCUMENTATION_36_GUIDE_FRANCAIS.md) | 15 min | Synthèse français | | [DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md](DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md) | 30 min | Vue technique complète | | [DOCUMENTATION_34_FEATURES_MATRIX.md](DOCUMENTATION_34_FEATURES_MATRIX.md) | 20 min | Matrice fonctionnalités | ### 📚 Documentations Complètes | Document | KB | Audience | Contenu | |----------|----|----|---------| | [DOCUMENTATION_10_ARCHITECTURE.md](DOCUMENTATION_10_ARCHITECTURE.md) | 43.7 | Développeurs | Système design, APIs, multithreading | | [DOCUMENTATION_11_FIELD_MAPPING.md](DOCUMENTATION_11_FIELD_MAPPING.md) | 56.3 | Admins, Devs | Extraction champs, fonctions, exemples | | [DOCUMENTATION_12_QUALITY_CHECKS.md](DOCUMENTATION_12_QUALITY_CHECKS.md) | 60.2 | Admins, QA | Validation, règles régression | | [DOCUMENTATION_13_EXCEL_EXPORT.md](DOCUMENTATION_13_EXCEL_EXPORT.md) | 29.6 | Devs | Export Excel, pipeline transformation | | [DOCUMENTATION_98_USER_GUIDE.md](DOCUMENTATION_98_USER_GUIDE.md) | 8.4 | Utilisateurs | Instructions, FAQ, troubleshooting | | [DOCUMENTATION_99_CONFIG_GUIDE.md](DOCUMENTATION_99_CONFIG_GUIDE.md) | 24.8 | Admins | Référence configuration Excel | ### 📊 Visuels | Document | Contenu | |----------|---------| | [DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md](DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md) | 10 diagrammes flux + ASCII art | | [DOCUMENTATION_34_FEATURES_MATRIX.md](DOCUMENTATION_34_FEATURES_MATRIX.md) | Matrice fonctionnalités, tableaux comparatifs | --- ## 🔗 Navigation Rapide ### Documents Principaux - [📋 DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md](DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md) - Vue complète - [🚀 DOCUMENTATION_32_QUICK_START.md](DOCUMENTATION_32_QUICK_START.md) - Démarrage rapide - [📊 DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md](DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md) - Diagrammes flux - [📖 DOCUMENTATION_36_GUIDE_FRANCAIS.md](DOCUMENTATION_36_GUIDE_FRANCAIS.md) - Documentation française ### Documentation Technique - [🏗️ DOCUMENTATION_10_ARCHITECTURE.md](DOCUMENTATION_10_ARCHITECTURE.md) - [🔍 DOCUMENTATION_11_FIELD_MAPPING.md](DOCUMENTATION_11_FIELD_MAPPING.md) - [✅ DOCUMENTATION_12_QUALITY_CHECKS.md](DOCUMENTATION_12_QUALITY_CHECKS.md) - [📈 DOCUMENTATION_13_EXCEL_EXPORT.md](DOCUMENTATION_13_EXCEL_EXPORT.md) ### Guides Utilisateurs - [👤 DOCUMENTATION_98_USER_GUIDE.md](DOCUMENTATION_98_USER_GUIDE.md) - [⚙️ DOCUMENTATION_99_CONFIG_GUIDE.md](DOCUMENTATION_99_CONFIG_GUIDE.md) ### Références Spécialisées - [✨ DOCUMENTATION_34_FEATURES_MATRIX.md](DOCUMENTATION_34_FEATURES_MATRIX.md) - Matrice fonctionnalités --- ## 📑 Tous les Documents ### Par Ordre Recommandé #### Premiers Pas 1. [DOCUMENTATION_32_QUICK_START.md](DOCUMENTATION_32_QUICK_START.md) ⭐⭐⭐ 2. [DOCUMENTATION_98_USER_GUIDE.md](DOCUMENTATION_98_USER_GUIDE.md) ⭐⭐ #### Fondamentaux Techniques 3. [DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md](DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md) ⭐⭐⭐ 4. [DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md](DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md) ⭐⭐ #### Configurations & Personnalisations 5. [DOCUMENTATION_99_CONFIG_GUIDE.md](DOCUMENTATION_99_CONFIG_GUIDE.md) ⭐⭐⭐ 6. [DOCUMENTATION_11_FIELD_MAPPING.md](DOCUMENTATION_11_FIELD_MAPPING.md) ⭐⭐⭐ #### Approfondissements 7. [DOCUMENTATION_10_ARCHITECTURE.md](DOCUMENTATION_10_ARCHITECTURE.md) ⭐⭐⭐ 8. [DOCUMENTATION_12_QUALITY_CHECKS.md](DOCUMENTATION_12_QUALITY_CHECKS.md) ⭐⭐ 9. [DOCUMENTATION_13_EXCEL_EXPORT.md](DOCUMENTATION_13_EXCEL_EXPORT.md) ⭐⭐ #### Références Complètes 10. [DOCUMENTATION_36_GUIDE_FRANCAIS.md](DOCUMENTATION_36_GUIDE_FRANCAIS.md) 11. [DOCUMENTATION_34_FEATURES_MATRIX.md](DOCUMENTATION_34_FEATURES_MATRIX.md) #### Ce Document 12. [DOCUMENTATION_35_NAVIGATION_INDEX.md](DOCUMENTATION_35_NAVIGATION_INDEX.md) ← Vous êtes ici --- ## 🎯 Quick Reference Checklist ### Avant de Démarrer - [ ] Python 3.7+ installé - [ ] Dépendances installées (`pip install ...`) - [ ] Fichier config `config/Endobest_Dashboard_Config.xlsx` présent - [ ] Identifiants Ziwig disponibles ### Pour Ajouter un Champ - [ ] Consulter [DOCUMENTATION_11_FIELD_MAPPING.md](DOCUMENTATION_11_FIELD_MAPPING.md) - [ ] Éditer feuille `Inclusions_Mapping` - [ ] Valider JSON dans colonnes - [ ] Tester avec `--excel_only` ### Pour Modifier Validation - [ ] Consulter [DOCUMENTATION_12_QUALITY_CHECKS.md](DOCUMENTATION_12_QUALITY_CHECKS.md) - [ ] Éditer feuille `Regression_Check` - [ ] Définir field_selection pipeline - [ ] Tester avec `--check-only` ### Pour Créer Rapport Excel - [ ] Consulter [DOCUMENTATION_13_EXCEL_EXPORT.md](DOCUMENTATION_13_EXCEL_EXPORT.md) - [ ] Ajouter ligne `Excel_Workbooks` - [ ] Créer/adapter template - [ ] Ajouter lignes `Excel_Sheets` - [ ] Tester avec `--excel_only` ### Pour Dépanner - [ ] Consulter [DOCUMENTATION_98_USER_GUIDE.md#troubleshooting](DOCUMENTATION_98_USER_GUIDE.md#troubleshooting) - [ ] Vérifier `dashboard.log` - [ ] Exécuter avec `--debug` - [ ] Consulter FAQ --- ## 📱 Format des Documents ### Markdown Tous les documents sont en Markdown (.md) - Lisible dans le navigateur GitHub - Éditable en texte simple - Support titre/listes/tableaux/code ### Navigation Interne Liens entre documents (relatifs, compatibles) Sections avec hashtags (`#section-name`) Tableaux de matières dans chaque document ### Code Exemples en Bash, JSON, Python Blocs de code syntaxiquement colorés --- ## 🔗 Liens Externes Importants ### Documentation du Projet - Fichiers DOCUMENTATION_*.md dans ce dossier - Configuration: `config/Endobest_Dashboard_Config.xlsx` - Logs: `dashboard.log` ### Références Externes - Python docs: https://docs.python.org/3/ - httpx docs: https://www.python-httpx.org/ - openpyxl docs: https://openpyxl.readthedocs.io/ --- ## 💡 Conseils de Navigation 1. **Première visite?** → Commencer par [DOCUMENTATION_32_QUICK_START.md](DOCUMENTATION_32_QUICK_START.md) 2. **Vous êtes Admin?** → [DOCUMENTATION_99_CONFIG_GUIDE.md](DOCUMENTATION_99_CONFIG_GUIDE.md) 3. **Vous êtes Dev?** → [DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md](DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md) 4. **Vous avez un problème?** → Chercher dans [DOCUMENTATION_35_NAVIGATION_INDEX.md](DOCUMENTATION_35_NAVIGATION_INDEX.md#-par-cas-dusage) (ce fichier) 5. **Vous cherchez quelque chose?** → [DOCUMENTATION_35_NAVIGATION_INDEX.md](DOCUMENTATION_35_NAVIGATION_INDEX.md#-par-sujet) 6. **Vous voulez apprendre le flux?** → [DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md](DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md) --- ## 📈 Couverture Documentation | Aspect | Couvert | Documents | |--------|---------|-----------| | **Démarrage rapide** | ✅ | QUICK_START_GUIDE | | **Architecture** | ✅ | SUMMARY + DOCUMENTATION_01 | | **Configuration** | ✅ | DOCUMENTATION_99 | | **Extraction champs** | ✅ | DOCUMENTATION_02 | | **Validation qualité** | ✅ | DOCUMENTATION_03 | | **Export Excel** | ✅ | DOCUMENTATION_04 | | **Guide utilisateur** | ✅ | DOCUMENTATION_98 | | **Troubleshooting** | ✅ | DOCUMENTATION_98 + QUICK_START | | **Diagrammes flux** | ✅ | VISUAL_FLOWCHART | | **Français** | ✅ | README_COMPLET_FR | | **Fonctionnalités** | ✅ | FEATURES_CAPABILITIES | --- ## 🎓 Programme d'Apprentissage Suggéré ### Jour 1 (1 heure) 1. [DOCUMENTATION_32_QUICK_START.md](DOCUMENTATION_32_QUICK_START.md) - 15 min 2. Lancer le script - 15 min 3. Consulter [DOCUMENTATION_98_USER_GUIDE.md](DOCUMENTATION_98_USER_GUIDE.md) FAQ - 15 min 4. Première exécution - 15 min ### Jour 2 (2 heures) 1. [DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md](DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md) - 45 min 2. [DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md](DOCUMENTATION_31_FLOWCHART_DIAGRAMS.md) - 45 min 3. [DOCUMENTATION_99_CONFIG_GUIDE.md](DOCUMENTATION_99_CONFIG_GUIDE.md) (intro) - 30 min ### Jour 3+ (Au besoin) - [DOCUMENTATION_11_FIELD_MAPPING.md](DOCUMENTATION_11_FIELD_MAPPING.md) - Pour ajouter champs - [DOCUMENTATION_12_QUALITY_CHECKS.md](DOCUMENTATION_12_QUALITY_CHECKS.md) - Pour modifier validation - [DOCUMENTATION_13_EXCEL_EXPORT.md](DOCUMENTATION_13_EXCEL_EXPORT.md) - Pour nouveaux rapports - [DOCUMENTATION_10_ARCHITECTURE.md](DOCUMENTATION_10_ARCHITECTURE.md) - Pour compréhension profonde --- ## ✅ Checklist Maîtrise du Système - [ ] J'ai lu [DOCUMENTATION_32_QUICK_START.md](DOCUMENTATION_32_QUICK_START.md) - [ ] J'ai exécuté le script avec succès - [ ] Je comprends les 5 phases d'exécution - [ ] J'ai consulté [DOCUMENTATION_99_CONFIG_GUIDE.md](DOCUMENTATION_99_CONFIG_GUIDE.md) - [ ] Je peux ajouter un nouveau champ - [ ] Je comprends les contrôles de qualité - [ ] Je peux créer un rapport Excel - [ ] Je sais lire dashboard.log - [ ] Je peux dépanner des erreurs basiques - [ ] J'ai lu [DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md](DOCUMENTATION_30_ARCHITECTURE_SUMMARY.md) --- ## 📞 Besoin d'Aide? 1. **Cherchez dans ce document** (DOCUMENTATION_35_NAVIGATION_INDEX.md) 2. **Consultez dashboard.log** (logs détaillés) 3. **Lisez FAQ** ([DOCUMENTATION_98_USER_GUIDE.md](DOCUMENTATION_98_USER_GUIDE.md)) 4. **Consultez documentation technique** (DOCUMENTATION_*.md) --- **Document Navigation Index** **Dernière mise à jour:** 2025-11-08 **Version:** 1.0 *Pour retourner à la documentation, cliquez sur le lien approprié ci-dessus.*