Documentation dynamique, consistante et "à la volée"

Back to Listing

Documentation dynamique, consistante et "à la volée"


23 Feb, 2016


Bonjour,

Un billet pour évoquer les bienfaits d'une documentation dynamique. Je ne sais comment appeler une telle documentation, n'hésitez pas à m'accompagner sur ce point, je pressens qu'il existe un terme plus approprié comme méta-documentation ou autre. J'entends par documentation dynamique, un document décrit comme une structure de représentation de données qui une fois généré va reproduire cette structure autant de fois qu'il y a de données à représenter.

Une telle documentation a des avantages considérables:

en termes de qualité car:

  • vous représentez vos données x fois, mais toujours de la même manière,
  • vous pouvez de plus réutiliser ces documents sur différentes sources de données (par exemple réutiliser un document dynamique sur un autre projet) et ainsi appliquer le même niveau de qualité à vos documents,
  • enfin car vos documents sont invariablement consistant de vos données puisqu'ils ne font que représenter la donnée disponible à l'instant t! Plus besoin de mettre à jour vos documents manuellement, ils se remplissent automatiquement sur base de vos données,

en termes de productivité car:

  • vous ne remplissez pas manuellement vos documents, vous indiquez comment ils doivent représenter vos données, et ils s'exécutent sur autant de données trouvées,
  • vous n'avez pas à appliquer d'effort lors des revues sur la structure et la qualité d'ensemble de la documentation, elle a déjà été validée lors de la création du document dynamique. Vos équipes qualité peuvent directement influer sur la qualité d'ensemble de la société en n'appliquant l'effort que sur les templates. Les revues elles, quant à elles, ne s'attachent qu'à ne valider que le contenu,
  • enfin, de même que pour la qualité, la capacité de réutilisation de ces documents dynamiques sur un tout autre jeu de donnée apporte en quelques clics la capacité pour votre organisation de reproduire la même documentation sur divers projets.

Remarquez l'effet levier que peut représenter la documentation dynamique sur le couple qualité/productivité, deux facteurs clés de la compétitivité de votre entreprise. Peut-être n'avez-vous pas encore bien saisi ce que représente une documentation dynamique ni même ce qu'elle implique dans la pratique. Pour cela, j'ai réalisé une petite vidéo d'introduction sur la documentation dynamique (mon premier webcast, soyez indulgent):

Share this story
comments powered by Disqus

 

Essayez Cockpit maintenant! Back to top