Aller au contenu

Inventaire de la documentation (Phase 0)

Recensement et classement Diátaxis de toute la doc technique/dev du pipeline GES. Établi le 2026-06-04 dans le cadre du plan rapports/plan-doc-automation-rtd-2026-06-03.md (Phases 0 et 1).

Audience cible : ingénieur GES / mainteneur du pipeline. Hors périmètre : les livrables client (rapports exec/scientifique/officiel — chaîne séparée, identité EGCC, bilingue).

bfev/docs/ — rangé en Diátaxis ✅

Document Mode Statut Note
index.md portail neuf carte des 4 sections
llms.txt portail neuf carte machine-lisible (agents)
CONTRIBUTING-docs.md méta neuf règles de rédaction
tutorials/getting-started.md tutorial déplacé ex-getting-started.md
how-to/packaging.md how-to déplacé ex-packaging.md
how-to/automatiser-la-doc.md how-to neuf Phase 3 — moteur de règles
build.yaml + build_docs.py outil neuf Phase 2 — manifeste + pilote
automation.yaml + run_automation.py + hooks/post-commit outil neuf Phase 3 — moteur d'automatisation
versioning.py outil neuf Phase 4 — versions _site/<tag>/, PR-preview, rétention
how-to/heberger-la-doc.md how-to neuf Phase 5 — runbook Dokploy
how-to/produire-les-livrables-client.md how-to neuf livrables exec+final PDF+DOCX, graphes nets
deploy/{Dockerfile,nginx.conf,docker-compose.yml} outil neuf Phase 5 — image statique + compose Dokploy
reference/contracts.md reference déplacé ex-contracts.md
reference/cheatsheet.md reference déplacé ex-cheatsheet.md
reference/testing.md reference déplacé ex-testing.md
reference/invariants-determinisme.md reference scindé moitié « faits » de l'ex-skill-upgrades.md
explanation/architecture.md explanation déplacé ex-architecture.md
explanation/strategie-residu-FE-bc.md explanation scindé moitié « pourquoi » de l'ex-skill-upgrades.md + doctrine D′
explanation/livrables-graphes-docx.md explanation neuf pourquoi dériver du scientifique, graphes hors-LLM, DOCX
~~skill-upgrades.md~~ supprimé fourre-tout scindé en 2 (cf. ci-dessus)
figures/*.svg actif conservé pipeline / sources-of-truth / crosscheck

Critère d'acceptation Phase 1 atteint : plus aucun document fourre-tout ; chaque page sert un seul mode.

Doc hors bfev/docs/ — recensée, non encore rangée

Source Rôle Mode cible Action
bfev/README.md porte d'entrée dépôt portail mis à jour (liens Diátaxis) ✅
bfev/plugin/skills/*/SKILL.md (×4) frontmatter opérationnel des skills reference garder tel quel (frontmatter), migrer la doc longue vers how-to/ + reference/ au besoin
bfev/plugin/agents/*.md (×5) définitions d'agents reference hors périmètre doc (config plugin)
rapports/transposition-robin-bfev/ note d'archi (source des upgrades) explanation source historique — à digérer vers explanation/ si besoin, sinon archiver
rapports/transposition-coscientist-bfev/ note d'archi explanation idem
rapports/pipeline-skill-upgrades/ (.qmd/.tex) rapport illustré des upgrades explanation rendu PDF — référencer depuis explanation/, ne pas dupliquer
rapports/plan-upgrades-skill-pipeline-2026-05-31.md plan d'implémentation plan, hors doc de référence
rapports/plan-doc-automation-rtd-2026-06-03.md ce plan plan, hors doc de référence

État des phases

  • Phase 0-1 ✅ — inventaire + arborescence Diátaxis (ci-dessus).
  • Phase 2 ✅ — manifeste docs/build.yaml + pilote docs/build_docs.py (HTML miroir + PDF quarto toléré). Une commande régénère tout le site.
  • Phase 3 ✅ — moteur docs/automation.yaml + run_automation.py (trigger×match×action, first_match_only) + hooks/post-commit.
  • Phase 4 ✅ — PR-preview (_site/_pr-<n>/) + versions (_site/<tag>/, coexistantes) + redirection racine + rétention. Actions publish / set-default / hide implémentées (versioning.py).
  • Phase 5 ✅ — hébergement Dokploy (option A) : image statique nginx + compose dokploy-network, runbook how-to/heberger-la-doc.md. Reste optionnel : brancher le transport de l'action notify (e-mail/webhook).