Confluence : 5 fonctionnalités majeures pour la rédaction de votre documentation technique - Valiantys - Atlassian Platinum Partner

Visionnez nos Webinars à la demande | Agilité à l'échelle, IT Service Management, Cloud, Bonnes pratiques Jira, Témoignages clients... Cliquez-ici !

valiantys-logo
Back

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

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.

Cutted Triangle

Inscrivez-vous à notre newsletter

Demande enregistrée ! Demande en cours... Ceci n'est pas un email Une erreur s'est produite

Conformément à notre politique de confidentialité, nous nous engageons à respecter vos données personnelles.

Contactez-nous

Nos consultants certifiés Atlassian seront ravis de vous répondre.

Rejoindre Valiantys

Nous sommes en train de construire un équipe extraordinaire. Vous en êtes ?

Suivez-nous

Nous utilisons des cookies pour le fonctionnement de ce site, pour améliorer son utilisation, personnaliser votre expérience et réaliser des statistiques de visite. Vous pouvez gérer les paramètres et choisir d’accepter ou non certains cookies durant votre navigation. Pour plus d’informations, consultez notre politique de confidentialité. Nos politique de confidentialité

Paramètres de confidentialité

Afin de faciliter votre navigation et de vous apporter le meilleur service possible, nous utilisons des cookies pour améliorer le site aux besoins des visiteurs, notamment selon la fréquentation.  Pour plus d’informations, consultez notre politique de confidentialité. Nos politique de confidentialité

Recaptcha

Google reCAPTCHA est un système conçu pour distinguer les humains des ordinateurs, de telle sorte que les bots soient incapables de remplir les formulaires de manière malveillante au nom d’un être humain.

Analytics

Utilisé pour envoyer des données à Google Analytics sur le périphérique et le comportement du visiteur. Suit l'internaute à travers les appareils et les canaux de marketing. Utilisé par Google Analytics pour diminuer radicalement le taux de requêtes. Enregistre un identifiant unique utilisé pour générer des données statistiques sur la façon dont le visiteur utilise le site.

LinkedIn

Cookies pour une publicité ciblée : Ces cookies peuvent être mis en place au sein de notre site Web par nos partenaires publicitaires. Ils peuvent être utilisés par ces sociétés pour établir un profil de vos intérêts et vous proposer des publicités pertinentes sur d'autres sites Web. Ils ne stockent pas directement des données personnelles, mais sont basés sur l'identification unique de votre navigateur et de votre appareil Internet. Si vous n'autorisez pas ces cookies, votre publicité sera moins ciblée.

Cookies "réseaux sociaux" : Ces cookies sont activés par les services proposés sur les réseaux sociaux que nous avons ajoutés au site Web afin de vous donner la possibilité de partager notre contenu avec votre réseau et vos connaissances. Ils nous permettent également de suivre votre navigation sur d’autres sites Web et d’établir un profil de vos intérêts. Cela peut avoir un impact sur le contenu et les messages affichés sur les autres sites Web que vous consultez. Si vous n'autorisez pas ces cookies, il se peut que vous ne puissiez pas utiliser ou visualiser ces outils de partage.