Rédaction de documents techniques sur Confluence : partie 3

Contenu ré-utilisé et structuré

Voilà le troisième volet de la série de billets dédiés à la rédaction technique sur les wikis ! Bonne lecture !

Voyons voir comment ré-utiliser du contenu et le structurer facilement.

Modelez votre  contenu avec le plus grand soin. Gardez-le à un endroit central où il peut être régulièrement maintenu et mis à jour. Ré-utilisez le autant que nécessaire. Nous avons vu précédemment que l’utilisation d’un wiki permettait de mettre en place une documentation technique structurée contrairement à ce que l’on pourrait penser. Dans ce billet nous verrons jusqu’où peut-on aller avec la ré-utilisation de contenus tout en maintenant une structure cohérente ainsi que les bénéfices retirés.

  • Parlons un peu de ces avantages :

Les contenus ré-utilisés au sein d’un wiki signifient que vous travaillez toujours sur la même page qu’importe le nombre de contributeurs, le process ou le contenu.

Il y a 4 raisons évidentes de ré-utiliser un contenu existant : cela permet de

1)      Gagner du temps

2)      Faire des économies

3)      Fournir de la matière

4)      Vous aider à reformuler et adapter votre contenu en fonction des différents publics et de leurs besoins

Ré-utiliser un contenu vous permet de vous concentrer sur la structure de votre librairie et d’assembler vos éléments sur la toile, ou de créer de nouvelles pages ou bien de personnaliser une collection de pages – chapitres, manuels de formation, fiches produits, etc… selon vos besoins. Un wiki vous fournit une plateforme collaborative complète et bien construite, transformez-là en arme collaborative !

Les utilisateurs d’outils pour la rédaction technique classique sont déjà habitués au concept de la séparation de contenu, de style, d’images et de codes ou de textes réutilisables. Vous penserez ici à comment  « designer » votre contenu HTML.

A première vue, vous ne feriez pas le choix d’un wiki pour les contenus à ré-utiliser – après tout, les wikis sont le résultat de la collaboration de chacun sur la même page et donc de la création d’un contenu collaboratif. Mais certains wikis comme Confluence ont des caractéristiques riches et assez  flexibles pour fournir un travail collaboratif nouveau tout en permettant une ré-utilisation des contenus existants. Voyez plutôt cet exemple :

Votre équipe a réalisé une série de FAQs pour un nouveau lancement de produit et l’équipe marketing a mis à jour tout le branding autour de ce produit. Vous mettez la documentation du produit à jour et aidez au développement de manuels de formation et fiches produits. Vous souhaitez utiliser des passages du FAQs et vous assurer que le nouveau branding est visible autour du produit.

  • La vitesse et le zen du contenu Ninja

Le bénéfice de contenus re-utilisés signifie que vous pouvez utiliser le texte du FAQs comme des inclusions de contenus n’importe où dans vos documents, et toutes vos pages avec des images de produits et des logos peuvent être rapidement mises à jour.

Librairies d’images

Votre wiki peut héberger toutes vos images à un seul endroit centralisé. Tout comme avec des outils de rédaction classiques, ces images peuvent être organisées au sein d’espaces séparés. Pour créer une librairie d’images, au lieu d’attacher vos images à chaque page, vous pouvez attacher vos images à une page simple et ensuite les inclure dans d’autres pages. Cela signifie que les images sont collectées, maintenues et référencées dans un répertoire central.

Votre librairie entière peut aussi être téléchargée dans un simple fichier zip pour les développeurs ou le marketing et mis à jours autant de fois qu’on le souhaite.

Laisser un commentaire

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

Captcha *

Ce site utilise Akismet pour réduire les indésirables. En savoir plus sur comment les données de vos commentaires sont utilisées.