Crealcs Development DokuWiki

Outils pour utilisateurs

Outils du site

Piste :
ujusum:3-codage:2-sprints:39.5-sprint-documentaire

Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Prochaine révision		Révision précédente
ujusum:3-codage:2-sprints:39.5-sprint-documentaire [2026/06/28 12:53] – créée 88.174.75.218ujusum:3-codage:2-sprints:39.5-sprint-documentaire [2026/06/28 16:29] (Version actuelle) – 88.174.75.218
Ligne 745: Ligne 745:
  
 ✓ aucune documentation n'est modifiée directement sur le site publié. ✓ aucune documentation n'est modifiée directement sur le site publié.
 +
 +----
 +
 +===== Recommandation d'implantation pour les applications =====
 +
 +Ma recommandation : 2 applications distinctes
 +
 +Elle ne sont intégrées ni à la Platform Console ni au Tenant Console.
 +
 +Cela se traduit par deux nouvelles interfaces.
 +
 +<code>
 +Platform Marketing Website
 +
 +Platform Console
 +
 +Tenant Console
 +
 +Owner Portal
 +
 +Guest Portal
 +
 +Experience Builder
 +
 +Documentation Portal   ← nouveau pour la consultation
 +
 +Documentation Console  ← nouveau pour la gestion
 +</code>
 +
 +Pourquoi ?
 +
 +Parce que la documentation concerne beaucoup plus de personnes que les administrateurs de la plateforme.
 +
 +Elles seront utilisées par :
 +
 +  * développeurs
 +  * testeurs
 +  * Product Owner
 +  * commerciaux
 +  * support
 +  * intégrateurs
 +  * consultants
 +  * partenaires
 +  * clients Enterprise
 +  * IA
 +
 +Elles méritent donc leur propre implantation.
 +
 +==== Définition des modes ====
 +
 +=== Mode Consultation ===
 +
 +Accessible à beaucoup de monde.
 +
 +Exemple :
 +
 +<code>
 +https://docs.rental-platform.com
 +</code>
 +
 +Menus :
 +
 +<code>
 +Accueil
 +
 +Recherche
 +
 +Playbooks
 +
 +Capabilities
 +
 +Procédures
 +
 +API
 +
 +Architecture
 +
 +Glossaire
 +
 +Diagrammes
 +
 +Release Notes
 +</code>
 +
 +Très proche de la documentation de Stripe.
 +
 +=== Mode Auteur ===
 +
 +Accessible uniquement aux équipes internes.
 +
 +<code>
 +Documentation Console
 +</code>
 +
 +Là, on retrouve une interface d'administration.
 +
 +Menus :
 +
 +<code>
 +Dashboard
 +
 +Playbooks
 +
 +Capabilities
 +
 +Procedures
 +
 +Templates
 +
 +Prompts
 +
 +Publications
 +
 +Git
 +
 +Validation
 +
 +AI Assistant
 +
 +Settings
 +</code>
 +
 +Ce n'est plus un wiki.
 +
 +C'est un CMS documentaire.
 +
 +<code>
 +apps/
 +
 +documentation-portal/
 +
 +documentation-console/
 +</code>
 +
 +=== Documentation Portal ===
 +
 +  * Public.
 +  * Lecture.
 +  * Recherche.
 +  * PDF.
 +  * Diagrammes.
 +  * Navigation.
 +  * API.
 +
 +  * --> Aucune édition.
 + 
 +=== Documentation Console ===
 +
 +  * Privé.
 +  * Authentification.
 +  * Edition.
 +  * Publication.
 +  * Validation.
 +  * Gestion Git.
 +  * Assistant IA.
 +
 +==== Les droits ====
 +
 +=== Documentation Portal ===
 +
 +  * Anonymous
 +  * Developer
 +  * Partner
 +  * Customer
 +  * Employee
 +
 +=== Documentation Console ===
 +
 +  * DOC_WRITER
 +  * DOC_REVIEWER
 +  * DOC_OWNER
 +  * SUPER_ADMIN
 +
 +==== L'architecture ====
 +<code>
 +Documentation Repository
 +
 +↓
 +
 +Documentation Generator
 +
 +↓
 +
 +MkDocs
 +
 +↓
 +
 +Documentation Portal
 +
 +et
 +
 +Documentation Console
 +
 +↓
 +
 +Git
 +
 +↓
 +
 +Repository
 +
 +↓
 +
 +Generator
 +
 +↓
 +
 +Publication
 +</code>
 +
 +==== L'IA ====
 +
 +C'est ici que ça devient intéressant.
 +
 +Le Documentation Console pourrait avoir un Workspace :
 +
 +<code>
 +AI Documentation
 +</code>
 +
 +avec :
 +
 +<code>
 +Créer un Playbook
 +
 +Créer une Capability
 +
 +Créer une Procédure
 +
 +Créer des Tests
 +
 +Créer une API
 +
 +Créer un Diagramme
 +
 +Créer les Prompts
 +
 +Vérifier la cohérence
 +
 +Préparer une Pull Request
 +</code>
 +
 +En réalité, le développeur ne rédige presque plus. Il valide.
 +Et pour aller encore plus loin; on peut créer un Documentation Engine, exactement comme on a maintenant un :
 +
 +<code>
 +Notification Engine
 +Workflow Engine
 +Search Engine
 +Theme Engine
 +</code>
 +
 +Le Documentation Engine serait un package partagé :
 +
 +<code>
 +packages/
 +
 +documentation-engine/
 +</code>
 +
 +Il fournirait :
 +
 +  * génération des menus ;
 +  * recherche ;
 +  * rendu Markdown ;
 +  * Mermaid ;
 +  * PlantUML ;
 +  * Front Matter ;
 +  * validation ;
 +  * graphes ;
 +  * indexation ;
 +  * publication.
 +
 +Ainsi, Documentation Portal et Documentation Console utiliseraient le même moteur, comme Platform Console et Tenant Console partagent déjà des moteurs (UX Platform, Search, Notifications, etc.).
 +
 +==== Au final ==== 
 +Ce n'est pas une interface isolée supplémentaire, mais un nouveau domaine fonctionnel de la plateforme :
 +
 +<code>
 +Documentation Platform
 +│
 +├── Documentation Engine (package partagé)
 +├── Documentation Console (back-office)
 +└── Documentation Portal (consultation)
 +</code>
 +
 +C'est cohérent avec l'architecture que nous avons construite jusqu'ici : chaque grand domaine (CRM, Billing, UX, Identity, Documentation...) possède son moteur partagé et une ou plusieurs interfaces spécialisées. À mon sens, cette organisation sera beaucoup plus pérenne qu'une intégration de la documentation dans la Platform Console.
  
ujusum/3-codage/2-sprints/39.5-sprint-documentaire.1782644027.txt.gz · Dernière modification : 2026/06/28 12:53 de 88.174.75.218 · Actuellement bloqué par : 192.168.0.100,216.73.216.20
DokuWiki Appliance - Powered by TurnKey Linux