Haut de page

Confluence : 5 fonctionnalités majeures pour la rédaction de votre documentation technique


Publié par
Elodie BARDAJI

28 août 2019

La qualité du contenu d’une documentation technique est bien évidemment l’élément le plus important. Mais sa mise en forme l’est presque autant.
Je dirais même plus, la puissance de votre documentation est intimement liée à sa lisibilité.
Dans cet article, nous allons découvrir cinq fonctionnalités qui permettent d’améliorer significativement la lisibilité et l’efficacité de votre documentation technique sous Confluence.

Génération automatique de la table des matières

Vous est-il déjà arrivé de parcourir désespérément une documentation technique à la recherche de l’information souhaitée ? Sûrement.

Alors pour faciliter la lecture de vos lecteurs et leur permettre d’accéder rapidement à l’information recherchée, pensez à utiliser dès aujourd’hui la macro {sommaire}.
Elle vous permettra de créer et de mettre à jour automatiquement une table des matières basée sur les différents niveaux de titre de votre page Confluence.
Vos lecteurs pourront ainsi naviguer dans la page en parcourant la structure de votre document.
Il est facile de passer les sections qui ne les intéressent pas pour accéder directement aux chapitres dont ils ont besoin.

Dans l’exemple ci-dessous, la macro {sommaire} (en anglais {table of content}) est utilisée au début de la page « Notes de publications de Confluence 6.15 ».
Il est possible d’exclure certains titres de la table des matières en sélectionnant les niveaux de titre à inclure dans la table des matières.

Mise en avant du contenu grâce aux encadrés personnalisés

Rien n’est plus indigeste à lire qu’une documentation monobloc, vous ne trouvez pas ?

Alors essayez la macro {volet} (en anglais {panel}), qui permet d’afficher différents types de contenus dans des encadrés personnalisés.
Elle fonctionne avec les blocs de texte, les images ou encore les vidéos.
Utilisez-la pour mettre en avant certains éléments ou définir des sections dans votre page.

Dans l’exemple ci-dessous, les encadrés servent à séparer les instructions du contenu informatif.
Par défaut la couleur de fond de l’encadré est un gris clair (si la charte graphique native de Confluence a été conservée), mais elle est paramétrable tout comme le titre, sa couleur et sa couleur de fond ou encore le type et la couleur de la bordure.

Bandeaux d’information préformatés

Les macros {remarque}, {avertissement}, {info} et {astuce} proposent chacune un bandeau de couleur différent associé à un pictogramme (facultatif).
L’association des deux apporte une signification visuelle au contenu : vert avec une coche pour les astuces, jaune avec un point d’exclamation pour les mises en garde…

Eléments à tiroirs

Quand il y a beaucoup de contenus dans une documentation technique, on aimerait pouvoir faire apparaître certains blocs de texte uniquement lorsque le lecteur en exprime le besoin. à la demande du lecteur. masquer des blocs d’informations et les afficher à la demande.

C’est possible avec la macro {développer} (en anglais {expand}), qui fonctionne avec les blocs de texte et les vidéos.

Vous voulez en savoir plus sur un point précis de la documentation ? Il suffit de déplier la boîte !

Remarque : cette macro n’est pas disponible nativement sous Confluence, mais le code est disponible gratuitement sur le site d’Atlassian.

Insertion de contenus multimédia

Avec internet et les contenus multimédia disponibles en ligne, vous pouvez rendre votre documentation technique attractive, animée et ludique, tout en conservant son rôle éducatif.

La macro {widget connector} permet d’inclure dans des pages Confluence des contenus provenant des sites web les plus populaires.
Vous pourrez ainsi afficher des vidéos YouTube, des messages Twitter, des documents et présentations SlideShare et Google Docs, des formulaires Wufoo…
Et ce ne sont que quelques exemples !

Vous en voulez encore ? Découvrez encore plus de fonctionnalités.

Si vous avez trouvé nos conseils utiles, n’hésitez pas à vous inscrire à notre newsletter mensuelle pour recevoir directement dans votre boîte email nos prochains articles de blogs.