Documentation & Tours guidés¶
Admin
Gérez les tours interactifs et les versions de la documentation depuis le panneau admin.
Vue d'ensemble¶
Le panneau Documentation permet de :
- Créer et modifier les tours guidés disponibles pour vos utilisateurs
- Consulter l'état des médias (screenshots, vidéos) par version
- Suivre les analytics d'utilisation de la documentation
- Gérer les versions de documentation (Super Admin uniquement)
Accéder au panneau documentation¶
- Connectez-vous avec un compte Admin ou Super Admin.
- Accédez à Administration > Documentation.
- Naviguez entre les onglets : Tours, Versions, Médias, Analytics.
Gestion des tours guidés¶
Créer un tour¶
- Dans l'onglet "Tours", cliquez sur "Nouveau tour".
- Renseignez les champs :
| Champ | Description | Exemple |
|---|---|---|
| Clé (kebab-case) | Identifiant technique unique | engagement-create |
| Nom FR | Libellé affiché à l'utilisateur | Créer un engagement |
| Module | Section de l'application | engagements |
| Rôle minimum | Rôle requis pour voir le tour | agent |
| Durée estimée | En minutes | 3 |
| Actif | Visible par les utilisateurs | oui / non |
- Cliquez sur "Enregistrer".
Modifier un tour existant¶
- Dans la liste des tours, cliquez sur "Modifier" sur la ligne souhaitée.
- Mettez à jour les champs.
- Enregistrez.
Désactiver un tour¶
Décochez la case "Actif" dans la fiche du tour. Le tour disparaît immédiatement de l'interface utilisateur.
Gestion des versions (Super Admin uniquement)¶
Les versions correspondent aux releases de l'application.
| Action | Description |
|---|---|
| Créer une version | Ajouter un tag (ex. v2.1) |
| Définir par défaut | Version affichée en priorité |
| Archiver | Masque la version de la liste publique |
| Reconstruire | Déclenche le pipeline CI/CD docs |
Rebuild
Le bouton "Reconstruire la documentation" déclenche un pipeline GitLab. L'opération peut prendre 5 à 10 minutes.
Analytics¶
L'onglet Analytics affiche pour les 30 derniers jours :
- Pages vues
- Recherches effectuées
- Tours démarrés / complétés
- Termes de recherche sans résultat (opportunités de contenu)
Permissions¶
| Action | Admin | Super Admin |
|---|---|---|
| Voir les tours | ✓ | ✓ |
| Créer / modifier un tour | ✓ | ✓ |
| Gérer les versions | ✓ | |
| Déclencher un rebuild | ✓ | |
| Voir les analytics | ✓ | ✓ |