EPIC — Documentation globale ProbatioVault (PD-191)¶
Intention¶
Structurer, produire et maintenir une documentation complète, cohérente et exploitable couvrant l'ensemble de ProbatioVault : architecture, API, cryptographie, exploitation et usages métiers.
Cette EPIC vise à faire de la documentation un actif stratégique au service : - des développeurs internes et partenaires, - des intégrateurs B2B / B2B2C, - des auditeurs (sécurité, conformité, juridique), - des utilisateurs finaux (B2C, B2B, B2B2C), - des investisseurs et institutions (BPI, cabinets, etc.).
Problème de fond¶
ProbatioVault repose sur une architecture complexe et différenciante : zero-knowledge, cryptographie avancée, WORM, blockchain, PRE, HSM, RLS…
Sans documentation structurée : - l'onboarding technique est lent et risqué ; - la compréhension du modèle de sécurité est fragile ; - la conformité et l'auditabilité sont difficiles à démontrer ; - la scalabilité humaine (devs, partenaires, clients) est limitée.
La documentation n'est pas un livrable secondaire, mais un pilier de crédibilité et de pérennité.
Solution de principe¶
L'EPIC DOCS organise la documentation selon plusieurs axes complémentaires :
- Documentation technique (API, architecture, cryptographie) ;
- Documentation développeur (installation, contribution, intégration) ;
- Documentation utilisateur (par typologie métier) ;
- Documentation opérationnelle (runbooks, incidents, procédures) ;
- Documentation partenaire (intégrations, workflows B2B/B2B2C).
La documentation est : - versionnée, - traçable, - alignée avec les EPICs et User Stories, - exploitable indépendamment du code (audits, appels d'offres).
Invariants¶
- Toute fonctionnalité critique doit être documentée.
- La documentation reflète l'architecture réelle (pas de divergence).
- Les flux cryptographiques sont explicités sans divulguer de secrets.
- Les runbooks sont actionnables en situation de crise.
- La documentation est maintenable et structurée (Markdown, MkDocs, etc.).
- Chaque public cible dispose d'un point d'entrée clair.
User Stories associées¶
- PD-164 — Rédiger documentation API OpenAPI / Swagger
- PD-165 — Créer guide installation développeur
- PD-166 — Rédiger guide architecture technique
- PD-167 — Créer documentation cryptographie
- PD-168 — Rédiger guides utilisateur (B2B / B2C / B2B2C)
- PD-169 — Créer documentation intégrations partenaires
- PD-170 — Rédiger runbooks opérationnels
Impacts transverses¶
-
Technique Meilleure compréhension du système, réduction du bus factor, accélération de l'onboarding.
-
Sécurité & conformité Capacité à démontrer les choix cryptographiques, la séparation des responsabilités, la conformité réglementaire.
-
Exploitation Réduction du MTTR, procédures claires en cas d'incident, exploitation industrialisable.
-
Business & partenariats Facilitation des intégrations, crédibilité accrue face aux grands comptes et institutions.
-
Produit & vision long terme Alignement constant entre roadmap, architecture et usage réel.
Références¶
- EPIC INFRA / CRYPTO / STORAGE / BLOCKCHAIN
- Architecture Executive & Architecture TechLead
- Spécifications Cryptographiques ProbatioVault
- NF Z42-013 / ISO 14641
- eIDAS, RGPD, exigences probatoires françaises