Documentation bfev¶
bfev orchestre un pipeline GES en 4 étapes (collecte → simulation → calcul →
rapports) à travers cinq agents Claude Code. Cette documentation est rangée selon
les quatre modes Diátaxis — apprendre / faire / consulter
/ comprendre. Chaque page sert une intention de lecture.
🎓 Tutorials — apprendre¶
Pas-à-pas guidés, un résultat concret. À lire en premier.
- Getting started — installer, configurer
$BFEV_HOME, lancer un premier audit.
🔧 How-to — faire¶
Recettes ciblées, orientées tâche, pour qui sait déjà où il va.
- Packaging & sharing — distribuer
bfev(wheel, image). - Automatiser le build de la doc — règles Git → rebuild (moteur d'automatisation).
- Héberger le portail (Dokploy) — servir
_site/en statique derrière Traefik. - Produire les livrables client — exécutif + final en PDF + DOCX, graphes nets, depuis le scientifique.
📖 Reference — consulter¶
Faits exacts : contrats, schémas, API, commandes. Aride et exhaustif.
- Cheatsheet — référence d'une page.
- Agent contracts — I/O exact de chaque agent.
- Testing & meta-testing — golden runs, contract tests.
- Invariants de déterminisme — I1/I2/I3, état du câblage des upgrades, commande d'audit.
💡 Explanation — comprendre¶
Le pourquoi, la doctrine, les arbitrages de conception.
- Architecture — l'orchestrateur + 4 sous-agents, le hand-off par artefacts.
- Stratégie du résidu FE — (b)+(c) — pourquoi récupérer-puis-gater, jamais estimer un nombre ; provenance vs conversion (D′-6).
- Livrables : graphes, DOCX, scientifique-source — pourquoi dériver du scientifique, rendre les graphes hors-LLM, sortir en DOCX.
Conventions : la doc dev est rédigée en français (la règle bilingue FR/EN ne vise que les livrables client). Règles de rédaction : CONTRIBUTING-docs.md. Carte machine-lisible pour agents : llms.txt. Recensement et classement : _inventory.md.