📖 Atelier Pratique #4
Créer un Espace de Documentation Confluence
⏱️ Durée : 45 minutes | 🛠️ Outil : Confluence
📋 Objectifs de l'Atelier
À la fin de cet atelier, vous serez capable de :
- Créer et structurer un espace Confluence
- Créer des pages avec hiérarchie (mère/enfant)
- Rédiger la Definition of Done (DoD)
- Rédiger la Definition of Ready (DoR)
- Utiliser le macro Jira Issues pour afficher des tickets
- Lier des pages Confluence à des Epics Jira
🚀 Prérequis
- Avoir accès à Confluence
- Avoir les droits de création d'espaces
- Avoir au moins un projet Jira avec des tickets
📝 Étape par Étape
Navigation :
- Cliquez sur (ou "Create space")
- Choisissez le type d'espace : "Espace d'équipe" (Team space)
- Remplissez les informations :
| Champ | Valeur Exemple |
|---|---|
| Nom de l'espace | Projet Formation SCRUM |
| Clé de l'espace | FORM (généré automatiquement) |
| Description | Espace de documentation pour le projet de formation SCRUM avec Jira et Confluence |
- Cliquez sur
Par défaut, Confluence crée une page d'accueil. Personnalisons-la :
- Sur la page d'accueil de votre espace, cliquez sur (icône crayon) en haut à droite
- Remplacez le contenu par :
# 🚀 Projet Formation SCRUM
Bienvenue dans l'espace de documentation du projet !
## 📌 Liens Rapides
- [Tableau Jira](lien-vers-votre-board)
- [Backlog Jira](lien-vers-votre-backlog)
- [Definition of Done](/DOD)
- [Definition of Ready](/DOR)
## 👥 Équipe
- **Product Owner:** [Nom]
- **Scrum Master:** [Nom]
- **Équipe de Développement:** [Noms]
## 🎯 Vision du Produit
Créer une application de gestion de tâches intuitive permettant aux utilisateurs d'organiser efficacement leur travail quotidien.
## 📊 Sprint Actuel
**Sprint 1 - MVP Authentification**
- Date de début : [Date]
- Date de fin : [Date]
- Objectif : Permettre l'inscription et la connexion des utilisateurs
- Cliquez sur en haut à droite
Arborescence Recommandée :
- 📁 Processus Agile
- 📄 Definition of Done (DoD)
- 📄 Definition of Ready (DoR)
- 📄 Workflow de l'équipe
- 📁 Documentation Technique
- 📄 Architecture
- 📄 Guide de développement
- 📁 Sprints
- 📄 Sprint 1 - Rétrospective
- 📄 Sprint 1 - Overview
Créer une Page Parent "Processus Agile" :
- Depuis la page d'accueil, cliquez sur en haut
- Sélectionnez "Page vierge" (Blank page)
- Titre : Processus Agile
- Ajoutez un contenu introductif
- Cliquez sur
- Depuis la page "Processus Agile", cliquez sur
- Titre : Definition of Done (DoD)
- Copiez le contenu suivant (adaptez à votre contexte) :
# ✅ Definition of Done (DoD)
Une User Story est considérée comme "Done" si et seulement si TOUS les critères suivants sont remplis :
## 📝 Code
- [ ] Le code est écrit et respecte les conventions de l'équipe
- [ ] Le code est versionné sur la branche appropriée
- [ ] Aucun code commenté ou console.log ne reste
- [ ] Les variables et fonctions ont des noms explicites
## 🧪 Tests
- [ ] Les tests unitaires sont écrits et passent (couverture > 80%)
- [ ] Les tests d'intégration sont écrits et passent
- [ ] Les tests manuels sont effectués
## 👀 Revue
- [ ] La revue de code est effectuée et approuvée par au moins 1 pair
- [ ] Les commentaires de revue sont adressés
## 📚 Documentation
- [ ] La documentation technique est mise à jour (README, API docs)
- [ ] Les commentaires de code sont clairs et à jour
- [ ] La page Confluence liée est mise à jour si nécessaire
## 🔍 Validation
- [ ] La Story est testée en environnement de recette
- [ ] Le Product Owner a validé la fonctionnalité
- [ ] Les critères d'acceptation sont tous remplis
## 🚀 Déploiement
- [ ] Le code est mergé sur la branche principale (main/master)
- [ ] Le build CI/CD passe avec succès
- [ ] Aucune régression détectée
## 📊 Qualité
- [ ] Aucun bug bloquant n'est ouvert
- [ ] La performance est acceptable (< 3s de chargement)
- [ ] L'accessibilité de base est respectée (contraste, labels)
---
**Important:** Si UN SEUL critère n'est pas rempli, la Story n'est PAS "Done" !
**Dernière mise à jour:** [Date]
- Cliquez sur
- Depuis la page "Processus Agile", cliquez sur
- Titre : Definition of Ready (DoR)
- Copiez le contenu suivant :
# 🎯 Definition of Ready (DoR)
Une User Story est considérée comme "Ready" (prête à être planifiée dans un Sprint) si TOUS les critères suivants sont remplis :
## 📝 Format
- [ ] La Story est rédigée au format standard : "En tant que... je veux... afin de..."
- [ ] Le titre est clair et explicite
- [ ] La Story respecte les critères INVEST
## 🎨 Clarté
- [ ] Les critères d'acceptation sont définis (au moins 3)
- [ ] Les critères sont clairs, testables et vérifiables
- [ ] Tous les acronymes et termes techniques sont expliqués
## 👥 Compréhension
- [ ] L'équipe comprend la valeur métier de la Story
- [ ] Les questions de clarification ont été posées et répondues
- [ ] Le Product Owner est disponible pour répondre aux questions
## 🎯 Estimation
- [ ] La Story a été estimée par l'équipe en Story Points
- [ ] L'estimation fait consensus (pas de désaccord majeur)
- [ ] La Story est suffisamment petite (≤ 13 points)
## 🔗 Dépendances
- [ ] Les dépendances techniques sont identifiées
- [ ] Les dépendances bloquantes sont résolues ou planifiées
- [ ] Les APIs ou services nécessaires sont disponibles
## 📐 Design
- [ ] Les maquettes UI/UX sont disponibles si nécessaire
- [ ] Les spécifications techniques sont suffisantes
- [ ] Les règles métier sont documentées
## ✅ Validation
- [ ] Le Product Owner a priorisé la Story
- [ ] La Story apporte de la valeur utilisateur claire
- [ ] L'équipe est confiante de pouvoir la réaliser
---
**Règle:** Seules les Stories "Ready" peuvent être sélectionnées en Sprint Planning !
**Dernière mise à jour:** [Date]
- Cliquez sur
Créer une page "Sprint 1 - Overview" :
- Créez une nouvelle page enfant sous "Sprints"
- Titre : Sprint 1 - MVP Authentification
- Dans l'éditeur, tapez / pour ouvrir le menu des macros
- Tapez "jira" et sélectionnez "Jira Issues"
Configuration du Macro Jira Issues :
Méthode 1 - Par filtre JQL :
- Sélectionnez "JQL"
- Entrez la requête :
project = FORM AND sprint = "Sprint 1" ORDER BY priority DESC
Méthode 2 - Par filtre sauvegardé :
- Sélectionnez "Saved Filter"
- Choisissez un filtre Jira existant
Options d'affichage :
| Option | Description | Recommandation |
|---|---|---|
| Display | Format d'affichage | Table (tableau complet) |
| Columns | Colonnes à afficher | Key, Summary, Status, Assignee, Story Points |
| Max issues | Nombre max de tickets | 50 (ou illimité) |
- Cliquez sur
- Le tableau Jira apparaît dynamiquement dans la page !
- Ajoutez du texte autour pour contexte
- Publiez la page
Étape 1 : Créer la page de spécifications
- Créez une nouvelle page : "Epic - Authentification Utilisateur"
- Ajoutez les spécifications détaillées :
# Epic : Authentification Utilisateur
## 🎯 Objectif
Permettre aux utilisateurs de créer un compte et de se connecter de manière sécurisée.
## 📊 Valeur Métier
- Protéger les données personnelles
- Personnaliser l'expérience utilisateur
- Respecter les normes RGPD
## 🔑 Fonctionnalités Incluses
1. Inscription avec email et mot de passe
2. Connexion avec email et mot de passe
3. Mot de passe oublié avec réinitialisation par email
4. Gestion de session (remember me)
5. Déconnexion
## 🎨 Maquettes
[Insérer images ou liens vers Figma]
## 🔐 Sécurité
- Hashage bcrypt des mots de passe
- Tokens JWT pour les sessions
- Rate limiting sur les tentatives de connexion
- Validation email obligatoire
## 📋 Stories Liées
[Macro Jira Issues filtré sur cet Epic]
## 📝 Notes Techniques
- Utilisation de Passport.js pour l'authentification
- MongoDB pour le stockage des utilisateurs
- SendGrid pour les emails
- Publiez la page
Étape 2 : Lier depuis Jira vers Confluence
- Ouvrez votre Epic "Authentification Utilisateur" dans Jira
- Dans la section "Liens" (Links), cherchez "Confluence Pages"
- Cliquez sur
- Recherchez et sélectionnez la page que vous venez de créer
- La page est maintenant liée ! Un lien apparaît dans l'Epic
- Créez une nouvelle page sous "Sprints"
- Au lieu de "Page vierge", cherchez "Retrospective" dans les templates
- Sélectionnez le template
- Titre : Sprint 1 - Rétrospective
- Le template pré-remplit la structure !
- Date et participants
- ✅ Ce qui a bien fonctionné (Keep doing)
- ⚠️ Ce qui peut être amélioré (Improve)
- 💡 Nouvelles idées à essayer (Try)
- 🎯 Actions décidées
Remplir la rétrospective :
## ✅ Ce qui a bien fonctionné
- Les Daily Scrums étaient efficaces et courts (15 min max)
- Bonne collaboration entre développeurs et testeurs
- Les limites WIP ont aidé à se concentrer
## ⚠️ Ce qui peut être amélioré
- Les Stories n'étaient pas toutes "Ready" en début de Sprint
- Trop de bugs découverts en fin de Sprint
- Documentation technique en retard
## 💡 Nouvelles idées à essayer
- Organiser une session de Backlog Refinement avant chaque Sprint
- Faire du pair programming sur les fonctionnalités complexes
- Créer un checklist de revue de code
## 🎯 Actions pour le prochain Sprint
1. [FORM-201] Planifier 2h de Refinement la semaine avant le Sprint
Responsable: Product Owner | Date: Avant Sprint 2
2. [FORM-202] Mettre à jour la DoD avec un critère de documentation
Responsable: Scrum Master | Date: Cette semaine
3. [FORM-203] Créer le checklist de revue de code dans Confluence
Responsable: Lead Dev | Date: Dans 3 jours
- Publiez la page
Ajouter des Labels :
- Ouvrez n'importe quelle page
- Cliquez sur "..." en haut à droite →
- Ajoutez des labels pertinents : "sprint-1", "processus", "technique"
- Les labels aident à retrouver les pages plus facilement
Gérer les Permissions (Optionnel) :
- Sur une page, "..." →
- Définissez qui peut voir/modifier la page
- Utile pour les documents sensibles ou RH
Vérifiez votre espace :
- Page d'accueil personnalisée avec liens rapides
- Section "Processus Agile" avec DoD et DoR
- Page "Sprint 1 - Overview" avec macro Jira Issues
- Page Epic liée à Jira
- Page Rétrospective avec template
- Arborescence claire visible dans le panneau gauche
Tester la navigation :
- Utilisez le panneau de gauche pour naviguer entre les pages
- Testez la recherche (loupe en haut) : tapez "DoD"
- Vérifiez les liens Jira → Confluence
- Testez le macro Jira Issues : modifiez un ticket dans Jira et rafraîchissez la page Confluence
🎨 Fonctionnalités Avancées
Macros Utiles :
| Macro | Utilisation | Raccourci |
|---|---|---|
| Jira Issues | Afficher des tickets Jira | /jira |
| Table of Contents | Sommaire automatique | /toc |
| Info/Warning/Note | Panneaux colorés d'alerte | /info, /warning |
| Expand | Section repliable | /expand |
| Status | Badge de statut (En cours, Done) | /status |
| Code Block | Bloc de code avec coloration | /code |
| Roadmap Planner | Timeline visuelle | /roadmap |
Raccourcis Clavier :
| Action | Windows/Linux | Mac |
|---|---|---|
| Éditer la page | E | E |
| Créer une page | C | C |
| Rechercher | / | / |
| Gras | Ctrl+B | ⌘+B |
| Italique | Ctrl+I | ⌘+I |
| Lien | Ctrl+K | ⌘+K |
✅ Bonnes Pratiques Confluence
📝 Rédaction :
- Titres clairs : Utilisez des titres explicites et hiérarchisés (H1, H2, H3)
- Paragraphes courts : Maximum 3-4 lignes par paragraphe
- Listes : Privilégiez les listes à puces pour la lisibilité
- Visuels : Ajoutez des images, diagrammes, tableaux
- Liens : Créez des liens entre pages connexes
🏗️ Organisation :
- Hiérarchie limitée : Max 3-4 niveaux de profondeur
- Nommage cohérent : Utilisez une convention (ex: "Sprint X - Nom")
- Page d'accueil centrale : Hub avec tous les liens importants
- Archivage : Archivez les vieilles pages plutôt que de les supprimer
🔄 Maintenance :
- Date de mise à jour : Ajoutez toujours la date de dernière modification
- Revue régulière : Relisez et mettez à jour les pages obsolètes
- Responsable : Assignez un responsable pour chaque page importante
- Notifications : Activez les notifications pour les pages critiques
❓ FAQ
Q: Quelle est la différence entre un espace et une page ?
R: Un espace est un conteneur de pages (comme un site web). Une page est un document individuel dans cet espace.
Q: Peut-on exporter une page Confluence ?
R: Oui ! "..." → Exporter → Choisissez PDF ou Word. Utile pour les présentations ou archives.
Q: Comment retrouver une vieille version d'une page ?
R: "..." → Historique de la page → Consultez toutes les versions et restaurez si besoin.
Q: Peut-on collaborer en temps réel dans Confluence ?
R: Oui ! Plusieurs personnes peuvent éditer simultanément. Vous voyez les curseurs des autres en temps réel.
Q: Comment mentionner quelqu'un dans une page ?
R: Tapez @ suivi du nom de la personne. Elle recevra une notification.
Q: Les macros Jira se mettent à jour automatiquement ?
R: Oui, mais parfois avec un léger délai (quelques minutes). Vous pouvez rafraîchir manuellement la page.
🎉 Félicitations !
Vous maîtrisez maintenant Confluence pour la documentation Agile. Votre équipe dispose désormais d'une source de vérité unique pour toute la connaissance du projet !
Prochaine étape : Atelier de synthèse finale - Simulation d'un cycle Scrum complet.