Dossier Documentation modulaire 1/5

Avant-propos

Pour un projet professionnel, j’ai eu à m’intéresser à la documentation modulaire. C’est une façon de gérer de l’information et de produire des documents différente de celle dont à l’habitude.

Ne connaissant pas grand-chose sur ce sujet, j’ai mené quelques recherches pour constater que l’on trouve assez peu de ressources en français sur ce thème.

Afin d’aider mes collègues à comprendre ce qu’est la documentation modulaire et ce qu’elle implique, j’ai réalisé une synthèse dont je publie aujourd’hui la première partie.

N’hésitez pas à consulter les liens hypertextes qui renvoient vers les références que j’ai consultées si vous voulez approfondir mes propos.

Et si vous avez des questions, des remarques, des retours des expériences, ou tout autre chose à faire partager, n’hésitez pas à commenter.

 Première partie : Le principe de la documentation modulaire

1.1. Définition

Commençons par expliquer ce dont on parle. Sur le blog de la société Sollan, on trouve la définition suivante : « La documentation modulaire consiste à découper le document en parties réutilisables (des « modules »), que l’on peut alors réutiliser dans d’autres documents. Construire un document modulaire revient alors à assembler et à organiser ces parties dans une table des matières. »

Avec la documentation modulaire, ce n’est plus le document qui est considéré comme unité principale d’information, mais chaque module représente une unité d’information indépendante.

 1.2. La granularité de l’information

La documentation modulaire exploite le principe de la granularité de l’information. Il s’agit de découper l’information au niveau le plus petit possible, mais de façon à ce qu’elle garde encore un sens.

Epis de maïsPour mieux comprendre, on peut prendre l’exemple de l’épi de maïs. Un grain de maïs se suffit à lui-même, il est parfaitement reconnaissable et compréhensible pris individuellement. Associé à d’autres grains dans une structure, il forme un autre objet : l’épi de maïs.

Les grains de maïs symbolisent les modules d’information (ou grain de contenu) et l’épi de maïs, le document.

La documentation modulaire consiste donc à assembler ces grains d’information pour former un tout cohérent : un document.

Une autre image qui est aussi souvent utilisée est celle du jeu de Lego avec les modules d’information à la place des briques, assemblés pour produire une forme reconnaissable.

1.3. La réutilisation de l’information

La documentation modulaire se base aussi sur le fait que les différents documents produits par l’entreprise (propositions commerciales, sites web, catalogues produits, manuels techniques…) contiennent des informations redondantes de l’un à l’autre.

Par exemple, la présentation de l’entreprise est toujours la même, quel que soit le support de communication considéré.

Réutilisation de modules d'information

Un même module d’information peut servir à plusieurs documents
Source : http://www.communication-technique.com/?q=redacteur-technique-modulariser-son-contenu-pour-mieux-le-valoriser

Ces mêmes informations sont bien souvent copiées/collées d’un document à l’autre. Le problème principal se pose quand il s’agit de mettre à jour une information. Pour reprendre l’exemple ci-dessus : l’entreprise acquiert une nouvelle certification qualité qu’il faut inclure dans sa présentation. Mais pour mettre à jour toutes les présentations, il faut reprendre un par un tous les documents où elle est utilisée, au risque d’en oublier. C’est par ailleurs un travail fastidieux.

Avec la documentation modulaire, lorsqu’un des modules d’information évolue, tous les documents qui l’utilisent sont automatiquement mis à jour. En effet, la brique de contenu initiale n’est pas dupliquée dans tous les documents qui l’utilisent, c’est un lien qui est fait entre le module et le document. La table des matières du document est constituée d’un ensemble de liens qui font référence à ces contenus.

Pourvu que les contenus de la base soient à jour et validés, les documents produits le seront également.

1.4. La valorisation et la capitalisation de l’information

Grâce à la documentation modulaire, il est plus facile de capitaliser et de valoriser les informations produites par l’entreprise.

Tous les grains de contenu présents dans la base sont destinés à être réutilisés : la présentation de l’entreprise, les références clients et leurs témoignages, les descriptifs des produits… Ces informations sont vivantes, s’enrichissent, circulent, elles ne restent pas à dormir au fin fond d’un disque dur, enfouies sous quatre ou cinq répertoires.

Par ailleurs, l’information est partagée. On perd moins de temps à réécrire une analyse sur un secteur de marché parce qu’on ne savait pas que notre collègue l’avait déjà écrite trois mois plus tôt. On voit que cette information existe dans la base et il ne reste plus qu’à la reprendre pour l’intégrer dans son propre document et éventuellement à l’adapter un peu.

1.5. La mise en forme

La documentation modulaire présente un intérêt pour ce qui est de la mise en forme. En effet, les contenus assemblés sont bruts, sans mise en forme. On sait que tel élément est un titre, mais on ne sait pas s’il est en rouge, en gras, en taille 18. On sait que tel paragraphe est une citation, mais il n’est pas forcément en italique.

Boutons-Content-DesignDans les documents classiques, créés avec des outils bureautiques comme les traitements de texte ou les logiciels de présentation, la mise en forme est inclue dans le corps du document, elle est insociable du contenu.

Alors qu’avec la documentation modulaire, on est sur le modèle des feuilles de style, comme celles appliquées sur les sites web.

Si la charte graphique de l’entreprise change, il suffit de modifier le fichier feuille de style pour que cette modification soit appliquée à tous les documents qui l’utilisent. C’est la même chose que pour la mise à jour du contenu. On n’a pas à reprendre chaque document individuellement.

 1.6. Les formats de publication

Le fait que les contenus soient bruts permet aussi de ne pas dépendre d’un format.

Avec les logiciels bureautiques, on est dépendant du format utilisé par le logiciel (indépendamment des questions posées par le fait que le format soit ouvert ou propriétaire). Un document créé avec un traitement de texte sera difficilement transposable en dans un format pour une présentation (type PowerPoint) ou sur un site web autrement que par copier/coller et travail supplémentaire sur la mise en forme.

La documentation modulaire permet d’obtenir des documents publiables dans des formats PDF, web, traitement de texte, présentation… tout dépend des canaux de publication mis en place.

Le contenu d’un manuel d’aide utilisateur peut par exemple être publié en format PDF, destiné à être imprimé et en format HTML pour une aide en ligne, très simplement à partir du même contenu.

Dans le prochain article, nous illustrerons ces notions par un cas concret. Rendez-vous la semaine prochaine.

3 réflexions sur “Dossier Documentation modulaire 1/5

  1. Pingback: Dossier Documentation modulaire 1/5 | D&IM ...

  2. Pingback: Dossier Documentation modulaire 1/5 | Bonnes pr...

  3. Pingback: Une nouvelle pratique : la documentation modula...

Laisser un commentaire

Entrez vos coordonnées ci-dessous ou cliquez sur une icône pour vous connecter:

Logo WordPress.com

Vous commentez à l'aide de votre compte WordPress.com. Déconnexion / Changer )

Image Twitter

Vous commentez à l'aide de votre compte Twitter. Déconnexion / Changer )

Photo Facebook

Vous commentez à l'aide de votre compte Facebook. Déconnexion / Changer )

Photo Google+

Vous commentez à l'aide de votre compte Google+. Déconnexion / Changer )

Connexion à %s