Confluence et la rédaction de documents techniques – Partie 1

Publié le 10 jan 11 - Écrit par Yann Debonnel 1 commentaire

Dans cet article, nous allons explorer les fonctionnalités de Confluence qui sont les plus utiles lors de la rédaction de documents techniques. Pour plus d’informations sur les macros Confluence, consultez l’article working with Macros.

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

Il est important de faciliter la navigation de votre page Confluence afin que vos lecteurs puissent rapidement passer à la section qui les intéresse. La macro table des matières aide vos lecteurs à naviguer au sein de longues pages en résumant la structure du contenu et en fournissant des liens vers les différentes sections de la page.

Un exemple :

  1. Vous documentez les nouvelles fonctionnalités pour la dernière version de votre produit dans une page Confluence.
  2. Chaque nom de fonctionnalité est une rubrique (heading) sur la page
  3. Vous pouvez maintenant générer une liste d’hyperliens vers chaque fonctionnalité en insérant une macro table des matières
  4. L’image ci-dessous montre la macro table des matières insérer en haut de page de la page ‘Release Notes’. Notez qu’ici la rubrique ‘Highlights of Confluence 3.4′ a été enlevée de la liste en modifiant les paramètres de la macro.
  5. L’image ci-dessous montre la paramétrisation de la macro table des matières dans notre exemple. Notez la valeur des champs ‘Minimum Heading Level’ et ‘Maximum Heading Level’

Insertion de liens d’ancrages

Les liens d’ancrages sont utiles lors de la navigation au sein d’un long document où lorsque vous voulez faire un lien vers un segment de page à partir d’une autre page. Pour ce faire, il vous faut utiliser la macro Ancre.

Un exemple :

  1. Vous documentez un guide utilisateur.
  2. Votre page est découpée en de multiples sections
  3. Après chaque section vous voulez fournir à vos lecteurs un lien pour  les remmener en haut de page.
  4. Pour atteindre cet objectif, vous devez d’abord créer une ancre en haut de la page en utilisant le macro ancre. Vous pouvez donner n’importe quel nom à votre ancre. Dans l’image ci-dessous, l’ancre de haut de page a été nommée ‘top’.
  5. Ensuite, vous pouvez créer un lien vers cette ancre de n’importe où sur la page en utilisant le navigateur de liens. L’image ci-dessous montre un lien vers l’ancre ‘top’ portant l’alias ‘Return to top of page’.

Pour tous vos besoins Confluence

Contactez-nous dès maintenant et nous regarderons ensemble comment nous pouvons vous aider à maximiser votre utilisation de Confluence.

Mots-clés : ,

One Trackback

  1. By Twitted by techsolcom on 10 janvier 2011 at 15 h 20 min

    [...] This post was Twitted by techsolcom [...]

Votre commentaire

Votre courriel ne sera jamais partagé. Les champs obligatoires sont marqus *