Guide utilisateur — DocApp
🚀 Let's start
DocApp est une plateforme de documentation interne. Elle se compose de deux espaces :
- Front-office (accès public) — lecture et recherche de documents
- Back-office /admin (accès authentifié) — création et gestion des contenus
Connectez-vous sur /admin/login avec vos identifiants pour commencer.
👤 Profil utilisateur
Rôles
| Rôle | Droits |
|---|---|
| ADMIN | Accès complet — documents, catégories, utilisateurs, toutes actions |
| EDITOR | Créer et éditer des documents — ne peut pas publier directement ni gérer les utilisateurs |
Sessions
Les sessions expirent automatiquement après 8 heures (conformité RGPD). Reconnectez-vous si vous êtes déconnecté.
📚 Les bases
Navigation front-office
- Accueil — liste des documents publiés récents
- Recherche — recherche full-text dans les titres, extraits et contenus
- Catégories — navigation par thème
- Tags — filtrage par mots-clés
Navigation back-office
- Tableau de bord — vue d'ensemble
- Documents — liste, création, édition
- Compositeur — assemblage de documents par fragments
- Catégories — gestion de l'arborescence
- Tags — gestion des étiquettes
- Utilisateurs — gestion des comptes (ADMIN uniquement)
✏️ Éditeur de documents
Créer un document
- Sidebar → Documents → bouton Nouveau document
- Remplir le titre, choisir une catégorie
- Rédiger le contenu dans l'éditeur TipTap
- Ajouter un extrait (résumé affiché dans les listes)
- Ajouter des tags si nécessaire
- Enregistrer en Brouillon ou Publier
Fonctionnalités de l'éditeur
| Outil | Usage |
|---|---|
| Titres H1–H3 | Structure du document |
| Gras / Italique / Souligné / Barré | Mise en forme du texte |
| Liste à puces / numérotée | Énumérations |
| Bloc de code | Extraits de code technique |
| Citation | Mise en avant d'une information |
| Tableau | Données structurées |
| Image | Upload (5 MB max, jpg/png/gif/webp) |
| Lien | URL interne ou externe |
Statuts d'un document
| Statut | Visibilité |
|---|---|
| DRAFT | Brouillon — visible uniquement en back-office |
| PUBLISHED | Publié — visible sur le front-office |
| ARCHIVED | Archivé — retiré du front, conservé en back-office |
Auto-sauvegarde
Les brouillons sont sauvegardés automatiquement toutes les 30 secondes. Un indicateur en haut à droite confirme la sauvegarde.
🧩 Fragments réutilisables
Un fragment est un document marqué comme réutilisable pour être assemblé dans le Compositeur.
Créer un fragment
- Ouvrir un document existant
- Activer le toggle Fragment réutilisable → sauvegarde automatique immédiate
- Le document apparaît avec un badge violet dans la liste
🎼 Compositeur de documents
Le Compositeur permet d'assembler plusieurs fragments en un nouveau document.
Process flow
- Sidebar → Compositeur
- Renseigner le titre et la catégorie du nouveau document
- Glisser les fragments depuis la bibliothèque (colonne gauche) vers la zone de composition (colonne droite)
- Réordonner par drag & drop selon l'ordre souhaité
- Cliquer Générer le document
- Le brouillon généré s'ouvre automatiquement pour finalisation
Le document généré est une copie indépendante — modifier un fragment après génération n'affecte pas le document créé.
🔍 Recherche full-text
La recherche utilise PostgreSQL avec pondération :
- Titre — poids A (prioritaire)
- Extrait — poids B
- Contenu — poids C
Les résultats affichent un extrait avec les termes trouvés surlignés.
👥 Gestion des utilisateurs (ADMIN)
- Sidebar → Utilisateurs
- Créer un compte avec rôle ADMIN ou EDITOR
- Les suppressions sont des soft-delete (conformité RGPD) — le compte est désactivé, pas supprimé physiquement
📁 Catégories
- Arborescence à 2 niveaux maximum
- Chaque catégorie a un nom, un slug, une description et un ordre d'affichage
- Les catégories parentes regroupent les sous-catégories