vendredi 8 avril 2011

Les outils de rédaction structurée

Lorsqu'il faut rédiger un document rassemblant les connaissances techniques d'un expert, parfois de manière relativement exhaustive, l'usage d'un traitement de texte ordinaire se révèle peu commode si l'on ne s'impose pas une discipline de rédaction structurée.
Il est en effet très facile d'obtenir une présentation incohérente sur l'ensemble du document (taille des titres qui varie, choix des polices différent pour deux paragraphes de niveau similaire, positionnement des figures centrée au début du document puis ajustées à gauche à la fin, numérotation automatique mal paramétrée...). Que le premier qui utilise MS Word sans jamais que son logiciel lui fasse des blagues de présentation me jette la première pierre.
Si en plus une ou plusieurs parties de ce document doivent être réutilisées par la suite, dans un document d'un type différent (présentation Powerpoint, site web) ou dans un document Word utilisant un style différent, le bon vieux copier-coller va créer des problèmes de mise en page qu'il va falloir corriger à la main et qu'il est parfois plus long de traiter que le temps nécessaire à la réécriture du texte.
Il existe aujourd'hui des outils de rédaction structurée qui se différencient du traitement de texte classique, qui peuvent en corriger les inconvénients et qui sont potentiellement plus judicieux pour rédiger un document complexe.
Passons en revue ces outils.

WYSIWYG ou WYSIWYM ?

Derrière ces acronymes obscurs se cache une différence de conception de la rédaction d'un document.
WYSIWYG (What You See Is What You Get, en français : ce que vous voyez est ce que vous obtenez) désigne la conception actuellement dominante de la rédaction de documents. Un traitement de texte WYSIWYG permet à l'utilisateur en cours de rédaction de voir le document à l'écran tel qu'il s'imprimerait sur papier s'il lançait l'impression immédiatement. Une caractéristique qui semble évidente aujourd'hui, voire indispensable. Cette conception a été rendue possible par le développement des environnements graphiques sur les ordinateurs.
Je me rappelle encore les versions de Word pour MS-DOS (avant que Windows ne se généralise sur les PC) où l'affichage en mode caractère ne permettait l'affichage que d'une seule police à l'écran et d'une seule taille de caractères. Il fallait deviner l'apparence du texte final sur l'imprimante, tester et corriger si nécessaire.
WYSIWYM (What You See Is What You Mean, en français : ce que vous voyez est ce que vous pensez) désigne une conception assez différente de la rédaction, qui consiste à rédiger le texte (le contenu) sans le formater, et de préciser pour chaque bloc de texte sa fonction (c'est un titre, c'est une citation, c'est un paragraphe ordinaire, c'est un exemple...) et éventuellement des attributs (ce bloc est important, ou écrit en langue étrangère...). La définition des fonctions ou des attributs est un balisage, car il se traduit généralement par l'introduction dans le texte de symboles (les balises), définissant le début ou la fin d'un bloc de texte ainsi que ses caractéristiques.
Dans un autre fichier (ou éventuellement dans une partie spécifique du même document), on précisera comment telle fonction ou tel attribut se traduit en terme de présentation (la forme). C'est la séparation du fond et de la forme.
Cette conception est familière à toute personne qui créé des pages web (c'est le principe du HTML pour le contenu et le balisage, et du CSS pour la forme), ou qui rédige des articles dans des wikis (le wikitexte définit le contenu, la forme étant gérée par le moteur wiki). Mais elle est bien antérieure à la conception WYSIWYG et existait déjà dans les années 1970, bien avant qu'Internet n'existe.
La séparation du fond et de la forme a les intérêts suivants :
  • cohérence de présentation : la présentation d'un même type de bloc de texte (exemple, citation, titre...) est la même tout le long du document ;
  • réutilisation : comme il n'y a pas de formatage dans le fichier de contenu, un copier-coller permet facilement de réutiliser des blocs de texte dans un autre document, et la mise en page s'adapte sans intervention ;
  • facilité de modification de la présentation : il suffit de changer les styles dans le fichier traitant de la présentation pour que l'ensemble du document soit mis à jour de manière cohérente ;
  • respect d'une charte graphique : une charte graphique se traduit par un fichier unique définissant la forme, commun à tous les contenus, ce qui fait que tous les documents produits respecteront la charte indépendamment du contenu rédigé.
Le système logiciel le plus connu de rédaction WYSIWYM est LaTeX (prononcez latek, car le X final est en fait un khi de l'alphabet grec). C'est un langage particulièrement connu du monde scientifique, car pendant longtemps ce langage n'avait pas d'équivalent dans les traitements de texte pour écrire des équations. Par contre, il est resté essentiellement limité au monde scientifique car son apprentissage nécessite un temps important, l'utilisation des balises étant beaucoup moins intuitif que l'appui d'un clic de souris sur un bouton pour mettre en gras un bloc de texte. De plus, tant qu'on rédige un document standard, tout va bien, mais lorsqu'il faut se lancer dans une mise en page personnalisée, c'est laborieux.
C'est à cause de ce manque d'intuitivité que LaTeX n'a sans doute jamais intéressé une autre population que les geeks et les scientifiques. Pourtant, il existe des solutions qui cachent le balisage LaTeX par une interface graphique relativement intuitive. Signalons par exemple Scientific Workplace, qui comme son nom l'indique est essentiellement destiné à la communauté scientifique, ou encore LyX, plutôt destiné aux geeks.
Ces logiciels ont le mérite de rassembler les avantages du WYSIWYG (l'intuitivité) et du WYSIWYM (la structuration). Toutefois, ces solutions ne sont sans doute pas suffisamment de valeur ajoutée pour justifier un changement d'habitude des utilisateurs de traitement de texte classiques. D'autant que l'introduction de modèles de documents dans ces derniers, et en particulier de styles (styles de paragraphe, de texte, de page) peuvent permettre à un utilisateur rigoureux de bénéficier d'une bonne partie des avantages du WYSIWYM.
L'usage d'outils de rédaction structurée est plus pertinente lorsqu'on rédige des documents complexes comme des documentations. Pour ces besoins, il existe des outils plus spécialisés.


DITA, Docbook ou Scenari ?

D'abord, avant les outils, parlons des formats. Il y a aujourd'hui deux formats relativement répandus de formats standard pour la documentation : DITA et Docbook, tout deux basés sur XML. Pour mémoire, XML (eXtensible Markup Language) est un format très versatile de langage à balises qui permet de créer ses propres balises selon ses besoins. Chaque format est en fait un ensemble de balises déterminé et de règles d'utilisation de ces balises.
Docbook, comme son nom l'indique, est un format de contenu destiné à rédiger des documentations. Ce format est issu de la documentation informatique (d'où une pléthore de balises spécifiques à l'informatique, en plus des balises généralistes qui conviennent à la plupart des besoins). Un document Docbook conçu comme une entité unique, comme un livre ou un article.
Egalement originaire du milieu de la documentation informatique, DITA (Darwin Information Typing Architecture) est a contrario un format conçu comme un ensemble de fiches qui peuvent être consultées indépendamment. Sa structuration modulaire en fait un outil plus adapté à une transformation en documentation informatisée, adaptable notamment à un site web ou a un document informatiques à liens hypertextes.
Les deux formats ont des avantages et des inconvénients, et l'on peut choisir l'un ou l'autre en fonction de ses besoins.
Toutefois, un fichier Docbook ou DITA est un fichier XML qui ne contient que du contenu et des balises. Pour obtenir un document, il faut lui faire subir une transformation qui incorpore la mise en forme. Il existe un format de transformation de documents XML appelé XSL (eXtensible Stylesheet Language), mais l'investissement pour l'apprendre est important. Il en existe heureusement déjà quelques uns, mais produire un résultat personnalisé est difficile et demande un effort informatique important.
Notons encore que ces formats ont besoin d'outils informatiques pour les manipuler : un éditeur, si possible intuitif, et un ou plusieurs moteurs de transformation. Un excellent éditeur gratuit est XMLMind XML Editor (ou XXE ; oui, il y a bien deux fois XML dans son nom...), et il contient quelques moteurs de transformations basiques.
Ces solutions sont donc à réserver aux professionnels de la documentation.
Une autre solution, un peu plus flexible quant aux types de documents produits et à leur finalité, est Scenari. Il s'agit d'un ensemble d'outils pour :
  • créer un format personnalisé de contenu (basé sur XML),
  • personnaliser une mise en forme de publication existante,
  • créer un éditeur et un moteur de transformation adapté à ce format,
  • éditer du contenu selon ce format,
  • produire des documents.
L'avantage majeur de Scenari par rapport à DITA et Docbook réside dans sa capacité à produire des documents multi-supports (comme par exemple du traitement de texte, de la présentation et des pages web) à partir du même contenu, et à intégrer des fichiers multimédia (video, audio...).
Une solution intéressante, donc. D'autant plus que certains éditeurs spécifiques ont été créés par l'équipe de Scenari, et sont des outils de production. Ainsi, Opale est un outil pour créer des supports de formation, Dokiel est un outil de documentation, WebRadio permet de créer une émission de radio sur internet à partir d'enregistrements audio...
Par contre, la documentation de Scenari laisse à désirer, notamment pour la personnalisation de l'apparence des documents texte. Et la création de son propre éditeur est un travail difficile voire quasi impossible sans documentation plus fournie et sans support de l'équipe Scenari.

Quel outil idéal ?

Un outil tel que Scenari me paraît s'approcher de ce qui serait utile à un médiateur technique chargé de synthétiser des connaissances d'experts dans un document.
Mais il manque à mon goût quelques caractéristiques à cet outil pour être vraiment l'outil qui fera oublier Word :
  • une documentation logicielle bien fournie : inutile d'être une solution Open Source si personne ne peut l'utiliser sans formation payante ;
  • une interface de développement de formats plus intuitive : on devine trop le code XML ou XSL sous-jacent, ce qui réduit l'intérêt pour le néophyte ;
  • un outil séparé de définition de la mise en forme : inutile de prétendre séparer fond et forme si la forme est quasiment fixée par le créateur du format de contenu ;
  • et, accessoirement, l'usage d'une technologie informatique plus rapide que le moteur Java, car un éditeur qui rame est particulièrement désagréable.
Sinon, je crains que les traitements de texte classiques restent encore longtemps incontournables malgré leurs inconvénients.

2 commentaires:

  1. Bonjour et merci pour cet article, il en existe trop peu sur ce sujet.
    Quelques commentaires:

    "Un document Docbook conçu comme une entité unique, comme un livre ou un article."
    En fait DocBook utilise le standard XInclude, pour construire des documents modulaires, de sorte qu'il est possible de publier une simple section d'une page ou un livre complet de 600 pages.

    "L'avantage majeur de Scenari par rapport à DITA et Docbook réside dans sa capacité à produire des documents multi-supports"
    DITA comme DocBook proposent une grande variété de feuilles de style pour les formats de sortie: PDF, HTML, ePUB, CHM, JavaHelp, Word, OpenOffice....

    Ma société NeoDoc (http://www.neodoc.fr) édite un CMS open source dédié à la documentation technique. Basé sur DocBook et DITA, la version non libre est notamment livrée avec XXE.

    RépondreSupprimer
  2. @Camille :

    Bonjour,

    Vous avez raison de dire que Docbook permet une gestion modulaire, ce qui évite de travailler sur un énorme fichier unique. Toutefois, à ma connaissance, Docbook est destiné à écrire des articles ou des livres, c'est-à-dire à produire des documents structurés pour être lus de manière linéaire et continue. C'est dans ce sens qu'il faut comprendre mon propos. Merci de m'avoir permis de préciser ceci.

    Concernant votre remarque sur Scenari et DITA/Docbook, je pense que mon article aurait dû effectivement être plus clair. Scenari est une chaîne éditoriale complète, alors que DITA et Docbook ne constituent que la partie "contenu" d'une chaîne éditoriale, qu'il faut compléter par des moteurs de transformation et des feuilles de style pour arriver à une chaîne complète. Bien sûr, il existe des feuilles de styles pour plusieurs supports, mais les feuilles de style libres sont assez peu nombreuses et assez peu sexy comparé à ce que propose Scenari. Mais que ce soit Scenari ou une feuille de style pour Docbook et DITA, obtenir des documents avec une charte graphique élaborée est difficile sans bagage technique,

    Votre offre est nouvelle pour moi. Peut-être que je trouverai mon bonheur ?

    SG

    RépondreSupprimer

Bonjour,

je vous remercie de laisser un commentaire. Je vous invite à le signer de votre nom, ou éventuellement d'un pseudo, pour faciliter l'échange.

Bien à vous,

SG