Essayer gratuitement

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èmeConséquenceSolution GitScrum
Documentation éparpilléeInformation introuvable quand nécessaireWiki centralisé avec recherche
Connaissances dans les têtesRisque quand quelqu'un partDocumentation partagée
Docs obsolètesÉquipe suit mauvaises procéduresHistorique et mise à jour facile
Emails perdus avec instructionsRe-demander constammentPages Wiki persistantes
Onboarding inefficaceNouveaux membres perdusBase 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émentDescriptionUtilisation
SectionsCatégories principalesArchitecture, Procédures, API
PagesArticles individuelsGuide de déploiement
Sous-pagesPages imbriquéesDétails par environnement
OrdrePosition dans le menuGlisser-déposer pour réorganiser

Zone de Contenu

L'article sélectionné affiche:

SectionDescriptionInteraction
TitreNom de la pageModifiable
MétadonnéesAuteur, date, dernière modificationAutomatique
ContenuCorps de l'article en MarkdownÉditeur riche
Table des matièresNavigation dans l'articleGénérée automatiquement
HistoriqueVersions précédentesComparer et restaurer
CommentairesDiscussions sur la pageOptionnel

Comment Utiliser

Créer une Page

  1. Accédez au Wiki de votre projet
  2. Cliquez sur Nouvelle page dans le coin supérieur
  3. Configurez la page:
  • Choisissez l'emplacement dans l'arborescence
  • Définissez un titre clair et descriptif
  • Sélectionnez la page parent (ou racine)
  1. Rédigez le contenu en Markdown:
  • Utilisez les titres pour structurer (# ## ###)
  • Ajoutez des listes pour les étapes
  • Incluez des exemples de code
  1. Prévisualisez vos changements
  2. Cliquez sur Sauvegarder

Organiser les Pages

  1. Planifiez votre structure avant de créer:
Section RecommandéeContenu Type
DémarrageSetup, prérequis, installation
ArchitectureDécisions techniques, diagrammes
ProcéduresDéploiement, rollback, debug
APIEndpoints, authentification, exemples
GuidesHow-to par fonctionnalité
RéférencesGlossaire, contacts, liens
  1. Créez les sections principales d'abord
  2. Glissez-déposez pour réorganiser l'ordre
  3. Imbriquez les pages liées sous leur parent
  4. Utilisez des liens internes entre pages

Éditer une Page

  1. Ouvrez la page dans le Wiki
  2. Cliquez sur Modifier (icône crayon)
  3. L'éditeur Markdown s'ouvre:
  • Mode édition avec syntaxe
  • Mode prévisualisation temps réel
  • Barre d'outils pour formatage rapide
  1. Faites vos modifications
  2. Ajoutez un message de commit (optionnel)
  3. Cliquez sur Sauvegarder

Rechercher dans le Wiki

  1. Utilisez la barre de recherche en haut
  2. Tapez des mots-clés pertinents
  3. Les résultats s'affichent instantanément:
  • Titre des pages correspondantes
  • Extrait du contenu
  • Section parent
  1. Cliquez pour accéder directement

Formatage Markdown

Éléments de Base

SyntaxeRenduUsage
# Titre 1Titre principalUn seul par page
## Titre 2Sous-sectionStructure principale
### Titre 3Sous-sous-sectionDétails
grasgrasMise en évidence
italiqueitaliqueTermes 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ément

Liens et Images

[Texte du lien](https://url.com)
[[Page Wiki interne]]
![Description image](url-image.png)

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émentSyntaxeSupport
Diagrammes Mermaid```mermaidOui
Formules Math$E=mc^2$Oui
Checkboxes- [ ] TâcheOui
Alertes> [!NOTE]Oui
Ancres[#section]Oui

Fonctionnalités Avancées

Historique des Versions

Chaque sauvegarde crée automatiquement une version:

ActionDescriptionComment
Voir l'historiqueListe des versionsOnglet Historique
ComparerDifférences entre versionsSélectionner 2 versions
RestaurerRevenir à une versionBouton Restaurer
Voir auteurQui 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

TypeExtensionsLimite
Images.png, .jpg, .gif, .svg5 MB
Documents.pdf, .docx10 MB
Archives.zip20 MB

Ajouter un attachement:

  1. Mode édition de la page
  2. Glissez-déposez le fichier
  3. Ou utilisez le bouton Attachement
  4. Le fichier est uploadé et lié

Export

FormatContenuUtilisation
PDFPage individuelle formatéePartage externe
MarkdownSource bruteSauvegarde locale
HTMLPage renduePublication 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

ActionMemberManagerAdmin
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

  1. Cliquez sur le bouton "Créer une page" en haut de la barre latérale
  2. La modale de création s'ouvre
  3. Entrez le titre de la page dans le champ requis
  4. Optionnellement, ajoutez du contenu initial
  5. Cliquez sur Créer

Depuis l'état vide

Quand le wiki n'a pas de pages :

  1. Voyez le message d'état vide
  2. Cliquez sur "Créer votre première page"
  3. Complétez la modale de création
  4. 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

  1. Survolez la page parente dans l'arborescence de la barre latérale
  2. Une icône "+" apparaît à droite
  3. Cliquez sur l'icône "+"
  4. La modale s'ouvre avec le contexte parent
  5. Entrez le titre de la sous-page
  6. 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

Après avoir cliqué sur Créer :

  1. La modale se ferme
  2. La nouvelle page apparaît dans l'arborescence
  3. Le contenu de la page se charge au centre
  4. 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 :

  1. Cliquez sur "Éditer la page" dans la barre latérale droite
  2. La page entre en mode édition
  3. Ajoutez votre contenu
  4. 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 :

  1. Créez une page nommée "[Template] Notes de réunion"
  2. Ajoutez la structure avec des espaces réservés
  3. 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éploiement

Runbook :

## Objectif

## Prérequis

## Étapes
1. 
2. 
3. 

## Vérification

## Rollback

## Escalade

Bonnes 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ôlePeut 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

ActionRaccourci
Soumettre le formulaireCmd/Ctrl + Entrée
Fermer la modaleÉchap
Focus sur le titreAuto-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

  1. Sélectionnez une page wiki
  2. Regardez la barre latérale droite
  3. Trouvez le bouton "Historique des révisions"
  4. Affiche le nombre de révisions (ex. "Historique des révisions (12)")
  5. 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 :

ChampDescription
Révision #Numéro séquentiel
DateQuand sauvegardé (relatif ou absolu)
AuteurQui a fait le changement
AperçuExtrait 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

  1. Cliquez sur n'importe quelle révision dans la liste
  2. Le panneau de prévisualisation affiche le contenu
  3. Vue en lecture seule de cette version
  4. 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

  1. Dans la modale des révisions, sélectionnez la première révision
  2. Maintenez Ctrl/Cmd et sélectionnez la deuxième révision
  3. Cliquez sur le bouton "Comparer"
  4. 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

  1. Ouvrez l'historique des révisions
  2. Sélectionnez la révision désirée
  3. Prévisualisez pour confirmer la bonne version
  4. Cliquez sur le bouton "Restaurer"
  5. 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

  1. Remarquez que du contenu manque
  2. Ouvrez l'historique des révisions
  3. Trouvez la dernière révision avec le contenu
  4. Prévisualisez pour confirmer
  5. Restaurez ou copiez-collez

Modification non souhaitée par un membre de l'équipe

  1. Voyez un changement avec lequel vous n'êtes pas d'accord
  2. Ouvrez l'historique des révisions
  3. Trouvez la révision avant le changement
  4. Discutez d'abord avec l'équipe
  5. Restaurez si accord

Comprendre l'évolution

  1. Nouveau sur le document
  2. Ouvrez l'historique des révisions
  3. Parcourez les versions
  4. Comprenez comment les décisions ont évolué
  5. Obtenez le contexte de l'état actuel

Résolution de conflit de fusion

Quand deux personnes ont édité :

  1. Voyez du contenu inattendu
  2. Comparez les révisions récentes
  3. Identifiez les deux contributions
  4. Fusionnez manuellement le meilleur des deux
  5. 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ôleVoir l'historiqueRestaurer
Agency Owner
Manager
Developer✓ (ses pages)
Client✓ (si vue activée)

Certains environnements peuvent restreindre l'accès à l'historique.