Guide utilisateur — DocApp

Documentation Pierre 07 avril 2026 3 vues

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ôleDroits
ADMINAccès complet — documents, catégories, utilisateurs, toutes actions
EDITORCré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

  • 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
  • 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

  1. Sidebar → Documents → bouton Nouveau document
  2. Remplir le titre, choisir une catégorie
  3. Rédiger le contenu dans l'éditeur TipTap
  4. Ajouter un extrait (résumé affiché dans les listes)
  5. Ajouter des tags si nécessaire
  6. Enregistrer en Brouillon ou Publier

Fonctionnalités de l'éditeur

OutilUsage
Titres H1–H3Structure du document
Gras / Italique / Souligné / BarréMise en forme du texte
Liste à puces / numérotéeÉnumérations
Bloc de codeExtraits de code technique
CitationMise en avant d'une information
TableauDonnées structurées
ImageUpload (5 MB max, jpg/png/gif/webp)
LienURL interne ou externe

Statuts d'un document

StatutVisibilité
DRAFTBrouillon — visible uniquement en back-office
PUBLISHEDPublié — visible sur le front-office
ARCHIVEDArchivé — 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

  1. Ouvrir un document existant
  2. Activer le toggle Fragment réutilisable → sauvegarde automatique immédiate
  3. 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

  1. Sidebar → Compositeur
  2. Renseigner le titre et la catégorie du nouveau document
  3. Glisser les fragments depuis la bibliothèque (colonne gauche) vers la zone de composition (colonne droite)
  4. Réordonner par drag & drop selon l'ordre souhaité
  5. Cliquer Générer le document
  6. 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