Wiki du Projet
Documentation collaborative pour partager les connaissances du projet, centraliser les informations techniques et préserver le savoir de l'équipe de manière organisée et accessible.
Le Problème que Cela Résout
| Problème | Conséquence | Solution GitScrum |
|---|---|---|
| Documentation éparpillée | Information introuvable quand nécessaire | Wiki centralisé avec recherche |
| Connaissances dans les têtes | Risque quand quelqu'un part | Documentation partagée |
| Docs obsolètes | Équipe suit mauvaises procédures | Historique et mise à jour facile |
| Emails perdus avec instructions | Re-demander constamment | Pages Wiki persistantes |
| Onboarding inefficace | Nouveaux membres perdus | Base de connaissances structurée |
Description Générale
Le Wiki permet de créer et organiser la documentation du projet en un seul endroit. Articles techniques, guides d'utilisation, procédures de déploiement, décisions architecturales — tout ce que l'équipe doit savoir est centralisé, versionné et accessible. Le Wiki utilise Markdown pour un formatage riche tout en restant simple à éditer.
Vue Principale
Arborescence de Navigation
Organisation hiérarchique des contenus:
| Élément | Description | Utilisation |
|---|---|---|
| Sections | Catégories principales | Architecture, Procédures, API |
| Pages | Articles individuels | Guide de déploiement |
| Sous-pages | Pages imbriquées | Détails par environnement |
| Ordre | Position dans le menu | Glisser-déposer pour réorganiser |
Zone de Contenu
L'article sélectionné affiche:
| Section | Description | Interaction |
|---|---|---|
| Titre | Nom de la page | Modifiable |
| Métadonnées | Auteur, date, dernière modification | Automatique |
| Contenu | Corps de l'article en Markdown | Éditeur riche |
| Table des matières | Navigation dans l'article | Générée automatiquement |
| Historique | Versions précédentes | Comparer et restaurer |
| Commentaires | Discussions sur la page | Optionnel |
Comment Utiliser
Créer une Page
- Accédez au Wiki de votre projet
- Cliquez sur Nouvelle page dans le coin supérieur
- Configurez la page:
- Choisissez l'emplacement dans l'arborescence
- Définissez un titre clair et descriptif
- Sélectionnez la page parent (ou racine)
- Rédigez le contenu en Markdown:
- Utilisez les titres pour structurer (# ## ###)
- Ajoutez des listes pour les étapes
- Incluez des exemples de code
- Prévisualisez vos changements
- Cliquez sur Sauvegarder
Organiser les Pages
- Planifiez votre structure avant de créer:
| Section Recommandée | Contenu Type |
|---|---|
| Démarrage | Setup, prérequis, installation |
| Architecture | Décisions techniques, diagrammes |
| Procédures | Déploiement, rollback, debug |
| API | Endpoints, authentification, exemples |
| Guides | How-to par fonctionnalité |
| Références | Glossaire, contacts, liens |
- Créez les sections principales d'abord
- Glissez-déposez pour réorganiser l'ordre
- Imbriquez les pages liées sous leur parent
- Utilisez des liens internes entre pages
Éditer une Page
- Ouvrez la page dans le Wiki
- Cliquez sur Modifier (icône crayon)
- L'éditeur Markdown s'ouvre:
- Mode édition avec syntaxe
- Mode prévisualisation temps réel
- Barre d'outils pour formatage rapide
- Faites vos modifications
- Ajoutez un message de commit (optionnel)
- Cliquez sur Sauvegarder
Rechercher dans le Wiki
- Utilisez la barre de recherche en haut
- Tapez des mots-clés pertinents
- Les résultats s'affichent instantanément:
- Titre des pages correspondantes
- Extrait du contenu
- Section parent
- Cliquez pour accéder directement
Formatage Markdown
Éléments de Base
| Syntaxe | Rendu | Usage |
|---|---|---|
# Titre 1 | Titre principal | Un seul par page |
## Titre 2 | Sous-section | Structure principale |
### Titre 3 | Sous-sous-section | Détails |
gras | gras | Mise en évidence |
italique | italique | Termes techniques |
~~barré~~ | ~~barré~~ | Obsolète |
Listes
- Élément liste à puces
- Autre élément
- Élément imbriqué
1. Premier élément numéroté
2. Deuxième élémentLiens et Images
[Texte du lien](https://url.com)
[[Page Wiki interne]]
Blocs de Code
`code inline` pour les commandes courtes
// Bloc de code avec coloration syntaxique function exemple() { return "Hello Wiki"; }
Tableaux
| Colonne 1 | Colonne 2 | Colonne 3 |
|-----------|-----------|-----------|
| Cellule 1 | Cellule 2 | Cellule 3 |
| Cellule 4 | Cellule 5 | Cellule 6 |Éléments Avancés
| Élément | Syntaxe | Support |
|---|---|---|
| Diagrammes Mermaid | ```mermaid | Oui |
| Formules Math | $E=mc^2$ | Oui |
| Checkboxes | - [ ] Tâche | Oui |
| Alertes | > [!NOTE] | Oui |
| Ancres | [#section] | Oui |
Fonctionnalités Avancées
Historique des Versions
Chaque sauvegarde crée automatiquement une version:
| Action | Description | Comment |
|---|---|---|
| Voir l'historique | Liste des versions | Onglet Historique |
| Comparer | Différences entre versions | Sélectionner 2 versions |
| Restaurer | Revenir à une version | Bouton Restaurer |
| Voir auteur | Qui a modifié | Affiché par version |
Liens Internes
Référencez d'autres pages du Wiki:
[[Nom exact de la page]]
[[Page|Texte personnalisé]]Avantages:
- Liens toujours valides même si la page est déplacée
- Détection des liens cassés
- Navigation fluide dans le Wiki
Attachements
| Type | Extensions | Limite |
|---|---|---|
| Images | .png, .jpg, .gif, .svg | 5 MB |
| Documents | .pdf, .docx | 10 MB |
| Archives | .zip | 20 MB |
Ajouter un attachement:
- Mode édition de la page
- Glissez-déposez le fichier
- Ou utilisez le bouton Attachement
- Le fichier est uploadé et lié
Export
| Format | Contenu | Utilisation |
|---|---|---|
| Page individuelle formatée | Partage externe | |
| Markdown | Source brute | Sauvegarde locale |
| HTML | Page rendue | Publication web |
Templates de Pages
Page de Procédure
# Procédure: [Nom]
## Objectif
Ce que cette procédure accomplit.
## Prérequis
- Prérequis 1
- Prérequis 2
## Étapes
1. Première étape avec détails
2. Deuxième étape
3. Troisième étape
## Vérification
Comment confirmer que c'est réussi.
## Rollback
En cas de problème, comment revenir en arrière.Page de Décision Architecturale (ADR)
# ADR-001: [Titre de la décision]
## Statut
Accepté | Proposé | Remplacé par ADR-XXX
## Contexte
Pourquoi cette décision est nécessaire.
## Options Considérées
1. Option A: Description, avantages, inconvénients
2. Option B: Description, avantages, inconvénients
## Décision
L'option choisie et pourquoi.
## Conséquences
Impact de cette décision.Meilleures Pratiques
Structure
- Gardez les pages focalisées (un sujet = une page)
- Utilisez une structure hiérarchique logique
- Limitez la profondeur à 3 niveaux maximum
- Créez une page d'index pour chaque section
Contenu
- Commencez par un résumé en début de page
- Utilisez des listes pour les étapes
- Incluez des exemples concrets et du code
- Ajoutez des captures d'écran pour les UI
Maintenance
- Révisez les pages régulièrement (marquez une date de révision)
- Archivez les pages obsolètes au lieu de les supprimer
- Assignez des "propriétaires" aux sections importantes
- Encouragez les contributions de toute l'équipe
Onboarding
- Créez un guide "Premier Jour" pour les nouveaux
- Documentez les accès et permissions nécessaires
- Listez les contacts clés et leurs responsabilités
- Incluez les liens vers les outils externes
Permissions
| Action | Member | Manager | Admin |
|---|---|---|---|
| Lire les pages | ✓ | ✓ | ✓ |
| Créer une page | ✓ | ✓ | ✓ |
| Modifier une page | ✓ | ✓ | ✓ |
| Voir l'historique | ✓ | ✓ | ✓ |
| Restaurer une version | ✗ | ✓ | ✓ |
| Supprimer une page | ✗ | ✓ | ✓ |
| Organiser l'arborescence | ✗ | ✓ | ✓ |
| Configurer le Wiki | ✗ | ✗ | ✓ |
Liens Connexes
Liens Connexes
Créer une page Wiki
Créez de nouvelles pages wiki pour documenter les connaissances, les processus et les spécifications techniques. Les pages peuvent être des documents de premier niveau ou des sous-pages imbriquées, supportant une organisation hiérarchique profonde pour des besoins de documentation complexes.
Créer une page racine
Les pages racines apparaissent au niveau supérieur de votre arborescence wiki.
Depuis la barre latérale
- Cliquez sur le bouton "Créer une page" en haut de la barre latérale
- La modale de création s'ouvre
- Entrez le titre de la page dans le champ requis
- Optionnellement, ajoutez du contenu initial
- Cliquez sur Créer
Depuis l'état vide
Quand le wiki n'a pas de pages :
- Voyez le message d'état vide
- Cliquez sur "Créer votre première page"
- Complétez la modale de création
- Votre première page est prête
Créer une sous-page
Les sous-pages s'imbriquent sous les pages existantes, construisant une documentation hiérarchique.
Depuis l'arborescence des pages
- Survolez la page parente dans l'arborescence de la barre latérale
- Une icône "+" apparaît à droite
- Cliquez sur l'icône "+"
- La modale s'ouvre avec le contexte parent
- Entrez le titre de la sous-page
- Cliquez sur Créer
La nouvelle page s'imbrique sous le parent dans l'arborescence de navigation.
Contexte parent
Lors de la création d'une sous-page, la modale affiche :
- Titre de la page parente
- Indicateur visuel de l'imbrication
- Confirmation de la hiérarchie
Cela aide à confirmer que vous créez au bon emplacement.
Champs de la modale
Titre de la page (Requis)
Objectif : Le nom qui apparaît dans la navigation et comme titre de la page.
Directives :
- Descriptif et spécifique
- 3-100 caractères
- Évitez les caractères spéciaux qui peuvent causer des problèmes d'URL
- Utilisez des conventions de nommage cohérentes
Bons exemples :
- "Guide d'authentification API"
- "Déploiement en production"
- "Notes de rétrospective Sprint 23"
Évitez :
- Mots uniques comme "Notes" (trop générique)
- Titres très longs (tronqués dans la navigation)
- Dupliquer les noms de pages existantes
Contenu initial (Optionnel)
Objectif : Démarrer la page avec du contenu au lieu de vide.
Format : Texte brut ou formatage style Markdown.
Cas d'utilisation :
- Coller du contenu existant
- Partir d'un template
- Notes rapides à développer plus tard
Si laissé vide, la page se crée vide—vous pouvez ajouter du contenu en mode édition après la création.
Après la création
Navigation immédiate
Après avoir cliqué sur Créer :
- La modale se ferme
- La nouvelle page apparaît dans l'arborescence
- Le contenu de la page se charge au centre
- Vous pouvez immédiatement commencer à éditer
Vue page vide
Les nouvelles pages sans contenu initial affichent :
- Titre de la page comme en-tête
- Zone de contenu vide
- Bouton Éditer pour ajouter du contenu
Mode édition
Pour ajouter du contenu après création :
- Cliquez sur "Éditer la page" dans la barre latérale droite
- La page entre en mode édition
- Ajoutez votre contenu
- Cliquez sur Sauvegarder
Organisation des pages
Choisir l'emplacement
Avant de créer, décidez de la hiérarchie :
Page racine quand :
- Catégorie majeure de documentation
- Référence autonome
- Page index ou hub
Sous-page quand :
- Liée à une page existante
- Partie d'un sujet plus large
- Expansion détaillée du parent
Restructurer plus tard
Les pages peuvent être déplacées après création :
- Glisser-déposer dans l'arborescence (si activé)
- Éditer la page pour changer le parent
- Créer une nouvelle page et copier le contenu
Considérations de profondeur
Bien que l'imbrication illimitée soit supportée :
- 2-3 niveaux sont généralement suffisants
- L'imbrication profonde rend la navigation plus difficile
- Utilisez des liens croisés au lieu d'arborescences profondes
Templates
Créer des pages templates
Configurez des templates réutilisables :
- Créez une page nommée "[Template] Notes de réunion"
- Ajoutez la structure avec des espaces réservés
- Quand nécessaire, copiez le contenu du template vers une nouvelle page
Suggestions de templates
Notes de réunion :
## Date : [DATE]
## Participants :
-
## Ordre du jour
1.
## Discussion
## Décisions prises
## Actions à faire
- [ ]
## Prochaine réunion :Spécification technique :
## Vue d'ensemble
## Énoncé du problème
## Solution proposée
## Conception technique
## Changements API
## Changements base de données
## Stratégie de test
## Plan de déploiementRunbook :
## Objectif
## Prérequis
## Étapes
1.
2.
3.
## Vérification
## Rollback
## EscaladeBonnes pratiques
Nommer de façon cohérente
Établissez des conventions d'équipe :
- "Comment..." pour les guides
- "[Composant] Architecture" pour les docs techniques
- "AAAA-MM-JJ Réunion" pour les notes
Commencer par la structure
Même avec le contenu initial vide :
- Planifiez vos titres
- Sachez quelles sections sont nécessaires
- Créez le plan d'abord
Lier à la création
Après la création :
- Liez depuis les pages connexes
- Ajoutez aux pages index
- Référencez dans les tâches pertinentes
Définir la propriété
Chaque page devrait avoir un propriétaire :
- Responsable des mises à jour
- Répond aux questions
- Révise périodiquement
Permissions
La création de page requiert les permissions appropriées :
| Rôle | Peut créer des pages |
|---|---|
| Agency Owner | ✓ |
| Manager | ✓ |
| Developer | ✓ |
| Client | ✗ (généralement) |
Les paramètres du projet peuvent davantage restreindre la création.
Dépannage
Bouton créer désactivé :
- Le champ titre peut être vide
- Vérifiez les champs requis
- Vérifiez les permissions
La page n'apparaît pas dans l'arborescence :
- L'arborescence peut nécessiter un rafraîchissement
- Vérifiez les erreurs de création
- Essayez de naviguer ailleurs et revenir
Impossible de créer une sous-page :
- La page parente doit être valide
- Vérifiez les permissions
- Assurez-vous que le parent n'est pas archivé
Erreur titre déjà existant :
- Les noms de pages doivent être uniques dans le projet
- Ajoutez de la spécificité au titre
- Vérifiez s'il existe une page similaire
Raccourcis clavier
| Action | Raccourci |
|---|---|
| Soumettre le formulaire | Cmd/Ctrl + Entrée |
| Fermer la modale | Échap |
| Focus sur le titre | Auto-focus à l'ouverture |
Historique des révisions Wiki
Chaque page wiki maintient un historique complet des versions. Chaque sauvegarde crée une révision, vous permettant de voir les versions passées, comparer les modifications, comprendre qui a modifié quoi, et restaurer le contenu précédent si nécessaire.
Comprendre les révisions
Qu'est-ce qu'une révision
Une révision est un instantané sauvegardé d'une page à un moment précis :
- Contenu : Texte complet de la page au moment de la sauvegarde
- Titre : Titre de la page (si modifié)
- Auteur : Qui a fait le changement
- Horodatage : Quand sauvegardé
- Numéro de révision : Identifiant séquentiel
Quand les révisions sont créées
Nouvelle révision créée quand :
- Page créée pour la première fois (révision 1)
- Mode édition sauvegardé avec des changements
- Restauration depuis une ancienne version
- Opérations d'import ou de mise à jour en masse
Rétention des révisions
Toutes les révisions sont préservées indéfiniment :
- Pas d'élagage automatique
- Piste d'audit complète
- Stockage optimisé pour le texte
Accéder à l'historique des révisions
Depuis la vue de la page
- Sélectionnez une page wiki
- Regardez la barre latérale droite
- Trouvez le bouton "Historique des révisions"
- Affiche le nombre de révisions (ex. "Historique des révisions (12)")
- Cliquez pour ouvrir la modale
Modale des révisions
La modale affiche :
- Liste de toutes les révisions
- Plus récentes d'abord (ordre décroissant)
- Chaque entrée montre : date, auteur, résumé
- Navigation pour les longues listes
Liste des révisions
Informations de l'entrée
Chaque révision affiche :
| Champ | Description |
|---|---|
| Révision # | Numéro séquentiel |
| Date | Quand sauvegardé (relatif ou absolu) |
| Auteur | Qui a fait le changement |
| Aperçu | Extrait ou résumé du changement |
Identifier les changements
Les révisions peuvent indiquer :
- "Page créée" pour la première révision
- "Contenu mis à jour" pour les éditions
- "Titre modifié" si le titre a changé
- "Restauré depuis révision X" pour les restaurations
Voir une révision
Prévisualiser le contenu
- Cliquez sur n'importe quelle révision dans la liste
- Le panneau de prévisualisation affiche le contenu
- Vue en lecture seule de cette version
- Contenu complet de la page affiché
Comparer avec l'actuel
La prévisualisation indique clairement :
- Ceci est du contenu historique
- La version actuelle peut différer
- Option de restauration disponible
Comparer les révisions
Ouvrir la vue diff
- Dans la modale des révisions, sélectionnez la première révision
- Maintenez Ctrl/Cmd et sélectionnez la deuxième révision
- Cliquez sur le bouton "Comparer"
- La modale diff s'ouvre
Comprendre les diffs
La comparaison affiche :
Contenu ajouté : Surligné en vert Contenu supprimé : Surligné en rouge Inchangé : Affichage normal
Vue ligne par ligne
Le diff affiche les changements contextuellement :
- Lignes ajoutées marquées avec +
- Lignes supprimées marquées avec -
- Contexte environnant pour la clarté
Diffs au niveau des caractères
Dans les lignes modifiées :
- Changements de mots spécifiques surlignés
- Suivi des modifications à grain fin
- Plus facile de repérer les petites éditions
Restaurer des révisions
Quand restaurer
La restauration est utile quand :
- Suppression accidentelle de contenu
- Une version précédente était meilleure
- Annulation des changements de quelqu'un d'autre
- Récupération après des erreurs
Processus de restauration
- Ouvrez l'historique des révisions
- Sélectionnez la révision désirée
- Prévisualisez pour confirmer la bonne version
- Cliquez sur le bouton "Restaurer"
- Confirmez la restauration
Après la restauration
- Le contenu de la page est remplacé par l'ancienne version
- Nouvelle révision créée (restauration tracée)
- Versions originales préservées
- Auteur de la restauration enregistré
La restauration est réversible
La restauration crée une nouvelle révision, donc :
- Vous pouvez restaurer à nouveau
- Rien n'est perdu définitivement
- Piste d'audit complète maintenue
Auditer les changements
Qui a changé quoi
L'historique des révisions répond à :
- Qui a modifié cette page en dernier ?
- Quand un contenu spécifique est-il apparu ?
- À quoi ressemblait-il avant ?
- Comment a-t-il évolué ?
Usage de conformité
Pour les environnements réglementés :
- Historique complet des changements
- Responsabilité de l'auteur
- Vérification des horodatages
- Pas d'historique supprimé
Responsabilité de l'équipe
Les révisions aident à :
- Former les nouveaux éditeurs
- Réviser les contributions
- Comprendre l'évolution de la documentation
- Résoudre les éditions conflictuelles
Bonnes pratiques
Sauvegardes significatives
Ne sauvegardez pas de changements vides ou triviaux :
- Complétez des unités logiques de travail
- Évitez les commits "corriger typo"
- Groupez les changements liés
Points de contrôle réguliers
Pour les longues sessions d'édition :
- Sauvegardez périodiquement
- Chaque sauvegarde est un point de récupération
- Mieux vaut avoir des révisions en plus
Réviser avant de restaurer
Avant de restaurer l'ancien contenu :
- Prévisualisez la révision
- Vérifiez ce qui pourrait être perdu
- Envisagez le copier-coller à la place
- Documentez pourquoi vous restaurez
Nettoyer par l'édition
Plutôt que de restaurer d'anciennes versions :
- Éditez la version actuelle pour corriger
- Conservez les améliorations accumulées
- Rollback sélectif si nécessaire
Limitations
Pas de restauration partielle
La restauration remplace la page entière :
- Impossible de restaurer un seul paragraphe
- Copier-coller pour la récupération partielle
- Fusion manuelle si nécessaire
Pas de suppression de révisions
Les révisions individuelles ne peuvent pas être supprimées :
- Historique complet préservé
- Par conception pour les fins d'audit
- Contactez le support pour les cas exceptionnels
Grandes révisions
Les pages très grandes peuvent :
- Prendre plus de temps pour le diff
- Avoir des aperçus tronqués
- Toujours fonctionner correctement
Scénarios courants
Suppression accidentelle de contenu
- Remarquez que du contenu manque
- Ouvrez l'historique des révisions
- Trouvez la dernière révision avec le contenu
- Prévisualisez pour confirmer
- Restaurez ou copiez-collez
Modification non souhaitée par un membre de l'équipe
- Voyez un changement avec lequel vous n'êtes pas d'accord
- Ouvrez l'historique des révisions
- Trouvez la révision avant le changement
- Discutez d'abord avec l'équipe
- Restaurez si accord
Comprendre l'évolution
- Nouveau sur le document
- Ouvrez l'historique des révisions
- Parcourez les versions
- Comprenez comment les décisions ont évolué
- Obtenez le contexte de l'état actuel
Résolution de conflit de fusion
Quand deux personnes ont édité :
- Voyez du contenu inattendu
- Comparez les révisions récentes
- Identifiez les deux contributions
- Fusionnez manuellement le meilleur des deux
- Sauvegardez la version combinée
Dépannage
Aucune révision ne s'affiche :
- Une nouvelle page n'a qu'une seule révision
- Vérifiez les permissions pour voir l'historique
- Essayez de rafraîchir la modale
Le diff ne fonctionne pas :
- Sélectionnez exactement deux révisions
- Vérifiez la compatibilité du navigateur
- Les très grandes pages peuvent timeout
La restauration échoue :
- Vérifiez les permissions d'édition
- Vérifiez que la page n'est pas verrouillée
- Des problèmes réseau peuvent interrompre
L'ancienne révision semble incorrecte :
- Le format change au fil du temps
- Le contenu est précis
- Le rendu peut différer
Permissions
L'accès aux révisions suit les permissions de la page :
| Rôle | Voir l'historique | Restaurer |
|---|---|---|
| Agency Owner | ✓ | ✓ |
| Manager | ✓ | ✓ |
| Developer | ✓ | ✓ (ses pages) |
| Client | ✓ (si vue activée) | ✗ |
Certains environnements peuvent restreindre l'accès à l'historique.