Thème
Checklist de revue documentaire
Grille de contrôle à appliquer à chaque page avant de merger. Elle garantit le respect des principes non négociables de Finoptika.
1. Métadonnées & cadrage
- [ ] Titre et
description(frontmatter) présents et spécifiques (SEO). - [ ] Persona(s) clairement identifié(s) dans « Qui l'utilise ».
- [ ] Permission RBAC requise indiquée (ex.
optimization:approve). - [ ] URL de l'écran indiquée (ex.
/optimization/inbox). - [ ] Chemin menu indiqué (ex. Optimize → Recommendation inbox).
2. Contenu fonctionnel
- [ ] Objectif en 1 paragraphe compréhensible sans contexte technique.
- [ ] Prérequis (données, connecteur, rôle) listés.
- [ ] Capture d'écran présente (ou placeholder annoté).
- [ ] Éléments de l'interface décrits (zones + actions).
- [ ] Workflow pas à pas numéroté et orienté tâche.
- [ ] Dépannage : au moins symptôme → cause → résolution.
- [ ] Voir aussi : liens internes pertinents.
3. Principes non négociables
- [ ] 🕒 Disclaimer de fraîcheur des données présent (pages dashboard).
- [ ] ⚠️ Disclaimer P90 présent si la page affiche des estimations.
- [ ] Distinction estimation / coût facturé / économie réalisée respectée.
- [ ] 💶 Rappel « montants en décimal » là où c'est pertinent.
- [ ] 🔒 Mention isolation tenant / cost center (RLS + RBAC) où applicable.
- [ ] 💱 Devises : pas d'agrégation multi-devises sans conversion explicite.
- [ ] Aucune donnée réelle ni secret dans les exemples.
4. Technique & cohérence
- [ ] Liens internes valides (
npm run docs:buildsans erreur). - [ ] Sidebar alignée sur
navigation.ts(npm run check:nav). - [ ] Encadrés
::: tip / warning / dangerbien formés. - [ ] Diagrammes Mermaid valides si présents.
- [ ] Termes techniques définis ou renvoyés au glossaire.
Critères d'acceptation transverses
- [ ] Un CFO comprend Savings proof sans aide technique.
- [ ] Un Tenant Admin configure Okta OIDC + rôles + cost centers via IAM/RBAC seul.
- [ ] Un analyste connecte AWS CUR et lance un ingest de bout en bout via Connecteurs + Ingest.
- [ ] La recherche trouve : « P90 », « chargeback », « RLS », « connecteur GCP », « dry-run ».