Blog
Les Bonnes Pratiques de Rédaction DITA (partie 3)
Certains rédacteurs techniques et spécialistes déclarent qu’il est trop compliqué de rédiger avec DITA et que la courbe d’apprentissage est trop abrupte. D’autres spécialistes et responsables de documentation assurent au contraire qu’ils peuvent avoir des nouveaux rédacteurs productifs sur DITA en deux heures. Cet article est le dernier d’une série d’articles ciblant les pratiques de rédaction que les rédacteurs doivent adapter, adopter, ou abandonner.
Laisser tomber la mise en forme
Cela paraît contre-intuitif mais laisser de côté les spécificités de certains produits ou de formats propriétaires peut être le plus difficile pour les rédacteurs. Lorsqu’elles adoptent DITA, les équipes doivent apprendre à travailler avec du contenu structuré et modulaire. Cela signifie que les rédacteurs techniques se concentrent sur le contenu lui-même mais plus sur sa mise en forme.
S’assurer que la puce de cette liste est parfaite, que l’indentation correspond au niveau du texte, changer la police du titre, etc. peut prendre jusqu’à 50 % du temps d’un concepteur d’information, voire même 80 % dans certains cas. Avec la rédaction structurée, une partie importante du temps peut être économisée grâce à l’application automatique de la charte graphique sur les différents formats et média.
Les bénéfices sont doubles :
- Du temps est dégagé pour développement du contenu
- La charte graphique est contrôlée par les feuilles de style, indépendamment du contenu
Laisser la mise en forme signifie aussi que la prochaine fois que l’organisation change de logo ou que la charte graphique est mise à jour, les équipes de contenus auront simplement à demander la mise à jour des feuilles de style une seule fois – et la modification ne devra pas être faite manuellement sur tous les documents.
Adapter l’expérience de rédaction
Nous avons déjà parlé de l’utilisation de balises plutôt que de styles dans le premier article de cette série. Toutefois, cela vaut la peine de souligner que la plupart des éditeurs modernes proposent une assistance aux rédacteurs qui facilitent la transition vers DITA.
Tout d’abord, les outils proposent une vue améliorée des contenus dans l’interface, ainsi l’outil fournit des indications visuelles pour le balisage et un exemple de mise en forme, par exemple pour la publication web.
Ensuite, dans l’éditeur, les balises obligatoires et optionnelles peuvent être implicitement proposées aux rédacteurs qui n’ont alors besoin que de remplir les valeurs de ces champs. Par exemple, l’éditeur peut vous proposer un champ de titre grisé dans lequel le rédacteur va entrer directement le titre. L’éditeur peut également proposer tous les champs attendus dans un avertissement de sécurité, sans que le rédacteur doivent ajouter manuellement ceux-ci : type de danger, conséquence, comment l’éviter.
Enfin, les rédacteurs peuvent aussi utiliser des formulaires, lorsque le contenu est fourni dans des listes déroulantes et adapté au modèle d’information utilisé par l’organisation.
Abandonner les vieux outils
Si certaines personnes adopteront les nouveaux usages, les nouveaux outils et systèmes sans regarder une seule fois en arrière, changer d’outils et de format peut s’avérer difficile pour d’autres. Surtout pour ceux sont des experts des outils et systèmes actuels.
Il est donc crucial de mettre en place une stratégie du changement réelle auprès de ceux qui pensent, à tort ou à raison, avoir à perdre avec l’adoption de DITA dans l’entreprise.
Dissocier responsabilité et rédaction de contenu
Le centre CIDM a réalisé plusieurs présentations et plusieurs enquêtes pour mieux comprendre le sens de la propriété développé par les rédacteurs techniques. Lorsque le contenu est modulaire et que des personnes différentes participent à la rédaction, les rédacteurs doivent :
- Réutiliser du contenu créé par quelqu’un d’autre
- Se retenir de modifier le contenu pour des raisons subjectives
Avec le contenu modulaire, le document final est bien la combinaison de plusieurs rubriques potentiellement rédigées par différent membres de l’équipe. Les responsabilités peuvent être donc séparées entre chaque partie et l’ensemble. Le responsable du document n’est donc pas nécessairement le rédacteur de tout le document.
Tout organiser dans un cadre de travail répétable
La meilleure façon d’organiser le travail et le contenu pour plusieurs rédacteurs est bien de créer un cadre de travail pour ceux-ci. Par exemple :
- Créer un guide de style DITA et vérifier l’application par des règles et des révisions formelles
- Utiliser des modèles de rubriques et de cartes, ainsi que des exemples
- Documenter le cycle de vie du contenu et la signification de chaque statut
- Vérifier avec votre architecture d’information, si l’ajout de contraintes ou une spécialisation peut aider les rédacteurs
- Organiser les équipes et les responsabilités : qui, quoi, quand
En fonction des outils, ces recommandations peuvent être renforcées. Chacun de ces points doit, bien sûr, être compris et validé par l’ensemble de l’équipe.
Vous commencez tout juste avec DITA? Gardez un œil sur ces symptômes
Même si la rédaction modulaire et structurée rend cela difficile, il est toujours possible de créer de mauvais contenus avec DITA. L’adoption du standard seul ne fera pas de grande différence si vous ne tenez pas un certain nombre de symptômes à l’œil. Les revues par les pairs sont efficaces, mais cette liste fournit un certain nombre de points problématiques :
- Il y a tellement de segments conditionnels dans la rubrique que la lecture en devient impossible pour les rédacteurs
- Vous avez des blocs de texte larges et denses, sans inter-titres
- Il y a tellement de liens entre rubriques que vous ne pouvez pas retrouver la première rubrique source (sans aucun lien)
- Il n’y a ni balises en ligne, ni métadonnées dans votre contenu
- Toutes les rubriques sont des rubriques non-typées (pas de séparation de base entre procédures, concepts et références)
- Incohérence dans le contenu. Indique souvent qu’il manque un guide rédactionnel, ou un guide de style, voire des modèles
Pour aller plus loin
Il y a de nombreuses ressources en ligne et accessibles gratuitement dont les publications des comités et sous-comités OASIS et les spécifications DITA bien sûr. Vous pouvez aussi :
- Lire un livre, par exemple le DITA Style guide or DITA Best Practices
- Essayer un site d’auto-apprentissage
- Suivre une formation ou un atelier
- Essayer des échantillons de contenus
Cet article clôt ainsi la série d’articles. Cette série est basée sur la présentation donnée à la conférence DITA Europe 2019 de Bruxelles “DITA Surprise! Unpacking Authoring Practices”.
—
Retrouvez la première partie et la deuxième partie de cette série de blogs.
—
Ce blog a été initialement publié dans la lettre d’information de CIDM, CIDM Matters.
Ressources
LearningDITA.fr : Source en ligne et gratuite pour apprendre les bases de la rédaction DITA
DITA Molière : Association pour la promotion du standard DITA
Auteur du blog
Nolwenn Kerzreho
Technical Account Manager at IXIASOFT
Avec plus d’une dizaine d’années d’expérience dans l’industrie de la communication technique, Nolwenn Kerzreho est Responsable Technique de Compte pour IXIASOFT en Europe. Point de contact privilégié de nos partenaires, Nolwenn est basée en France. Elle intervient régulièrement dans les conférences internationales, les colloques et les universités françaises où elle présente DITA depuis 2009. Nolwenn a une expérience internationale dans les domaines de la chimie, Telecom, l’industrie langagière et le développement logiciel.
Vous pouvez contacter Nolwenn sur Twitter à @NolwennIXIASOFT
Inscrivez-vous à notre lettre d’information dès maintenant pour rester informé des tendances de l’industrie techcomm et des dernières actualités IXIASOFT!