Formats et outils
Pour industrialiser la rédaction technique, le format importe plus que l’outil. Comparez les formats propriétaires comme Word et FrameMaker aux standards ouverts comme DITA XML et DocBook pour votre contexte.
Définition
Section intitulée « Définition »Lorsqu’une entreprise décide d’industrialiser la rédaction technique, elle se pose d’emblée la question des outils. Or, plutôt que les outils, ce sont les formats sous-jacents qui sont le point essentiel.
La plupart des éditeurs, afin de disposer d’un marché captif obligé de régulièrement payer des mises à jour de leurs produits, ont en effet développé des formats propriétaires que seuls leurs logiciels sont à même de modifier. Un fichier MS Word ou un fichier FrameMaker ne peuvent ainsi être modifiés que via les outils éponymes. Choisir un tel format risque donc de limiter les choix ultérieurs de l’entreprise et de se révéler coûteux : il faut une licence par utilisateur, qu’il soit rédacteur technique, contributeur occasionnel ou traducteur.
Un format standard laisse le choix de l’outil.
Principes clés
Section intitulée « Principes clés »Si l’on réfléchit en termes de formats, en revanche, il est possible de mettre en place des solutions évolutives. Un format ouvert tel que OpenDocument ou DITA XMLUne architecture de rédaction structurée et modulaire, construite autour de la typologie concept/tâche/référence et de la réutilisation de contenu via conrefs et ditamaps.Voir dans le glossaire →, par exemple (seul le second étant un format industriel de rédaction technique), n’est pas lié à un outil donné. Il est donc possible de le modifier et de le manipuler à l’aide de différents logiciels. Les formats structurés de type DocBookLangage de balisage XML sémantique destiné à la documentation technique, organisé en livres, chapitres et sections plutôt qu'en topics typés. Antérieur à DITA XML, il sert de point de comparaison habituel lors du choix d'un format structuré.Voir dans le glossaire → et DITA XML liés à un schéma XSD (XML Schema Definition)Le langage de schéma XML du W3C, lui-même écrit en XML. Les schémas XSD de DITA XML définissent les éléments autorisés dans chaque type de topic ; un fichier qui ne les respecte pas échoue à la validation, ce qui limite aussi ce que les conrefs et le texte conditionnel peuvent produire.Voir dans le glossaire → normalisé peuvent notamment être facilement gérés, de la création à la publication, à l’aide de toute une panoplie d’outils, de l’éditeur de texte libre à la suite logicielle propriétaire et graphique.