Confluence : Guide des bonnes pratiques

Francis MartensNon classifié(e)Leave a Comment

Confluence bonnes pratiques

Cet Article a été écrit par notre consultant Atlassian – Atlassian Hero Damien Lauberton

Confluence bonnes pratiquesDans une organisation grandissante ou changeante, la place de Confluence prend de plus en plus d’importance et les usages se diversifient selon vos besoins : intranet d’entreprise, formulaires de contact, stockage de données et de fichiers, liens vers des plateformes externes, nombre grandissant d’utilisateurs internes et externes, workflow d’approbation, etc. Le passage à une version Data Center est parfois nécessaire ou conseillé selon les usages actuels et à venir de votre instance.

Avec cette version, la scalabilité de votre Confluence est largement facilitée aussi bien techniquement (infrastructure, maintenance et mise à jour technique du produit) que fonction

nellement avec quelques fonctionnalités d’administration particulières. C’est aussi le bon moment pour revoir l’organisation de vos espaces et leur structure de contenu si nécessaire : étendre les usages de Confluence dans votre organisation nécessite un peu plus d’encadrement et de règles permettant de conserver une cohérence entre vos espaces de documentation et vos processus de gestion associée.

Ce guide va vous aider à aborder l’expansion de vos usages Confluence et éventuellement le passage en version Data Center. Elles ne sont pas exhaustives ou obligatoires, ce sont des conseils pour vous aider à mieux organiser votre Confluence que ce soit sur une instance existante ou sur le lancement de la plateforme dans votre organisation.

Tables de matières

Espace

documentation Atlassian : https://confluence.atlassian.com/doc/spaces-139459.html

Qu’est ce qu’un espace dans Confluence ? Un espace est un ensemble de pages et d’articles de blog, permettant à une personne, une équipe, un projet de saisir et d’entreposer de la documentation. C’est le contenant, celui qui va entreposer tous le contenus que vous voulez stocker en lien avec le sujet principal de l’espace.

On utilise un espace Confluence entre autre pour :

  • une équipe ou plusieurs équipes,
  • tous les collaborateurs de la société (intranet d’entreprise),
  • un projet ou plusieurs projets,
  • un produit ou un ensemble de produits,
  • pour un client ou un groupe de clients.

Il n’y pas de limites du nombre d’espaces possibles dans Confluence à ma connaissance, mais plus il y en a, plus les règles de gouvernance et l’organisation de votre plateforme seront importantes et vivement conseillée pour maintenir une cohérence dans vos documentations et processus projet ou de gestion.

organisation des espaces d'une instance Confluence

organisation des espaces d’une instance Confluence

Nom et Clé d’un Espace

documentation Atlassian : https://confluence.atlassian.com/doc/create-a-space-139463.html

Des règles de nommage vont vite devenir obligatoires avec la multiplication des espaces dans votre organisation :

  • Ne pas utiliser ou peu de caractères spéciaux dans les noms d’espace, cela n’est pas utile et va complexifie la recherche et l’accès au contenu de chaque espace.
  • Définir une clé de l’espace simple : si un espace Confluence est lié à un projet Jira, l’utilisation de la même clé d’espace et de projet Jira serait intéressant pour faciliter les accès et la mémorisation.
  • Utiliser et définir des catégories d’espaces pour catégoriser et trier ces espaces et faciliter leur accès et recherche.
  • Définir des règles de nommages des noms et clés d’espaces par type, par nom de projet ou d’équipe est important :
    • utiliser des préfixes par type, par exemple :
      • EQP pour équipe,
      • PRJ pour les projet,
      • CLI pour les projets clients,
      • INT pour l’intranet d’entreprise
    • suivi d’un nom parlant et explicite :
      • MARKETING pour l’équipe en question
      • IDALKO pour le nom d’un client
      • le code projet ou la référence projet
    • et puis simplement un nom explicite et clair exprimant le contenu de l’espace si nécessaire
    • un exemple pour un espace client :
      • nom de l’espace : CLI – iDalko – Atlassian JIRA CONFLUENCE
      • clé de l’espace : CLIIDALKOATL par exemple

confluence répertoire des espaces

répertoire des espaces

Gestion d’un espace

documentation Atlassian : https://confluence.atlassian.com/conf59/administer-a-space-792498663.html

Ranger et réorganiser régulièrement vos espaces jusqu’a trouver la meilleur structure adaptée à la taille actuelle de l’espace, qui va continuer de se remplir en page et contenu. En respectant quelques règles, déplacer du contenu n’est pas un problème tant que vos pages racines sont dynamiques et mise à jour si nécessaire :

  • Identifier des personnes qui aideront à ranger, trier et organiser les espaces et leur contenu régulièrement (1 à 2 fois par mois selon les usages).
  • Une page d’accueil d’espace dynamique composée en grande partie de macros de contenu pour l’accès à ce dernier, ainsi même si le contenu est déplacé, l’accès à ce contenu est toujours garanti.
  • Hiérarchiser les pages et leur contenu : trier, ranger le contenu par hiérarchie permettant ainsi d’avoir plusieurs pages racines, par sujet de contenu.
  • Définir une hiérarchie par défaut si nécessaire par type d’espace : cela aidera chaque collaborateur pour accéder au contenu des espaces, selon son type, la hiérarchie et l’organisation sera la même.

page d'accueil d'un espace Confluence

exemple de page d’accueil d’un espace

Étiquettes (ou labels)

documentation Atlassian : https://confluence.atlassian.com/doc/add-remove-and-search-for-labels-136419.html

Les étiquettes utilisées dans Confluence sont globales à toute l’instance, de la même manière que les noms d’espaces, il est important de définir des règles de nommage pour maintenir une cohérence, faciliter l’accès au contenu et l’organisation générale partagée à travers toutes vos équipes :

  • de base dans Confluence, toutes les étiquettes sont composé par caractère minuscule uniquement.
  • identifier un séparateur pour toutes vos étiquettes : par exemple le « – » ou « _ »en général le tiret simple est le plus utilisé.
  • gérer les étiquettes et connaître les plus utilisés :
    • liste des étiquettes utilisé sur un espace : URL DE BASE CONFLUENCE /labels/listlabels-alphaview.action?key=CLE DE L’ESPACE
    • liste de toutes les étiquettes utilisées sur tous les espaces : URL DE BASE CONFLUENCE /labels/listlabels-alphaview.action
    • liste des étiquettes les plus populaire sur tous les espaces : URL DE BASE CONFLUENCE /labels/listlabels-heatmap.action

étiquettes d'une instance Confluencetoutes les étiquettes d’une instance Confluence

Pages d’un espace

documentation Atlassian : https://confluence.atlassian.com/doc/create-and-edit-pages-139476.html

Les pages sont utilisées pour la documentation de projet, d’équipe, de processus d’activité, de bases de connaissances et tout autre type de documentation nécessaire au fonctionnement d’un projet, de la société ou d’une équipe. Afin de faciliter l’organisation d’un espace, suivez quelques règles liées aux pages :

  • Hiérarchisation des pages obligatoires, avec structure et organisation du contenu,
  • Proposer une hiérarchie de base pour les espaces en fonction de leur type, ainsi les utilisateurs retrouveront la même hiérarchie partout en fonction du type d’espace,
  • Ne pas avoir trop de niveau hiérarchique : 5 niveaux restent maintenables, au delà cela peut devenir compliqué à maintenir et n’aidera pas l’accès au contenu,
  • Utiliser les modèles de page au maximum pour partager la structure d’une page,
  • Utiliser les étiquettes de pages pour trier et organiser vos pages par sujet,
  • Nommer vos pages avec des noms explicites, en limitant les caractères spéciaux dans le nom des pages,
  • Ne pas créer de page vide, toujours créer une page avec un minimum de contenu pour ne pas frustrer vos utilisateurs.
  • Éviter de créer des pages trop longues et trop riches en contenu, découpés une grosse page en pages plus petites vous permettra de mieux réutiliser le contenu et ainsi éviter les duplications de contenu.

d'arborescence de page pour un espace Confluence

exemple d’arborescence de page pour un espace de type Produit

Blog d’espace

documentation Atlassian : https://confluence.atlassian.com/doc/blog-posts-834222533.html

Les articles de blog sont généralement utiliser pour la communication, comme par exemple pour :

  • diffuser des informations sur la vie de l’espace,
  • animer les équipes / projets / produits de l’espace,
  • ou même partager des connaissances et savoir-faire en lien avec l’espace.

Voici quelques bonnes pratiques en complément de celles à utiliser pour les pages :

  • utiliser des mots clés de référence dans les articles de blog pour permettre des recherches effectives de contenu,
  • et bien sûr utiliser les étiquettes pour catégoriser les articles de blog comme les pages,
  • nommer vos articles avec des noms explicites, en limitant les caractères spéciaux dans le nom des articles.

Le blog est largement utilisé sur un espace Confluence de type intranet pour faciliter toute la communication interne à la société à destination de tous les collaborateurs.

Le blog peut être désactivé selon le type d’espace et selon le besoin de l’espace si nécessaire.

Confluence Hiérarchisation des articles de blog automatique par mois

Hiérarchisation des articles
de blog automatique par mois

Favoris et Tableau de bord

documentation Atlassian : https://confluence.atlassian.com/doc/the-dashboard-139374.html

Sur la page d’accueil de Confluence, appelée aussi Tableau de bord, des liens permettent de lister du contenu dynamiquement :

  • Les pages récemment créées,
  • Les pages les plus populaires et largement visitées par les utilisateurs de la plateforme,
  • Vos derniers travaux : les pages que vous avez éditées récemment,
  • Visités récemment : les pages que vous avez visités récemment sans modification,
  • Sauvegardés pour plus tard : les pages que vous avez ajoutées à vos favoris.

Menu racine de Confluence

Menu racine de Confluence

Les macros incontournables

documentation Atlassian : https://confluence.atlassian.com/doc/macros-139387.html

L’utilisation des macros dans Confluence va vous permettre d’étendre les capacités de vos pages Confluence vous autorisant à ajouter des fonctionnalités étendues et du contenu dynamique. Nous allons lister ici les macros les plus utilisés pour créer des pages dynamiques basés sur le contenu et sur le contenant.

  • Include Page Macro – macro Inclure page : la plus pratique de macros pour éviter la duplication de contenu, cela permet d’afficher le contenu d’une page dans une autre page.
  • Attachments Macro – macro Pièces jointes : permet à la fois d’ajouter des pièces jointes sur une page par glisser / déposer mais aussi de lister (et filtrer) les pièces jointes d’une page.
  • Excerpt Macro – macro Extrait : permet d’ajouter un extrait de contenu à une page, visible ensuite dans pleins d’autres macros de contenu.
  • Related Labels Macro – macro Étiquettes associées : permet d’afficher les étiquettes associées à une ou plusieurs autres étiquettes de contenu.
  • Labels List Macro – macro Liste d’étiquettes : liste des étiquettes d’un espace
  • Recently Used Labels Macro – macro Étiquettes récemment utilisées : liste les étiquettes récemment utilisées dans un espace.
  • Content by Label Macro – macro Contenu par étiquette : affiche des pages portant le ou les étiquettes mentionnées.
  • Content by User Macro – macro Contenu par utilisateur : affiche le contenu rédigé par un utilisateur
  • Content Report Table Macro – macro Rapport de contenu : permet de lister les pages portant une ou plusieurs étiquettes.
  • Create from Template Macro – macro Créer à partir d’un modèle : affiche un bouton de création de page via un modèle.
  • Table of Contents Macro – macro Sommaire : affiche de manière dynamique le sommaire d’une page (en utilisant les différents formats de titre utilisé sur une page).
  • Children Display Macro – macro Affichage enfants : affiche toutes les pages enfants de la page sur laquelle la macro est utilisée.
  • Page Tree Macro – macro Arborescence des pages : permet d’afficher une arborescence de pages.
  • Page Tree Search Macro – macro Recherche de l’arborescence de pages : permet de recherche dans l’arborescence de pages.

macros Confluence

toutes les macros Confluence

Conclusionatlassina Confluence

Toutes ces bonne pratiques et conseils vont vous permettre de structurer et organiser le contenu de votre plateforme Confluence. Quand une organisation grandit ou choisit Confluence comme plateforme d’entreprise unique de documentation, il est important de définir quelques règles et une organisation associée à vos besoins dans le but d’uniformiser vos processus et documentation.

Vous souhaitez essayer Confluence gratuitement ? Rien de mieux pour découvrir le produit et commencer à le prendre en main… Accéder au site d’Atlassian et démarrez votre évaluation (évaluation gratuite pendant 7 jours en version Cloud et 30 jours en version serveur). Vous allez rapidement voir par vous-même la puissance de cet outil et l’intérêt pour vos équipes d’utiliser une telle plateforme. Associée avec Jira Software, les capacités de vos équipes seront encore démultipliées grâce à la gestion des tâches et demandes projets directement en lien avec la documentation de votre projet. La productivité de vos équipes va aussi être améliorées, car la prise en main de ces deux outils Atlassian est assez simple et surtout rapide.

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *