Pour rédiger un contenu qui soit cohérent, facile à réutiliser et à mettre à jour, les rédacteurs techniques doivent respecter les règles de rédaction DITA. Certaines d’entre elles dépendent du modèle d’information, d’autres du guide de style.
- Terminologie
- Style
- Formulation sous forme d’instruction conditionnelle
- Conventions d’appellation
- Métadonnées
- Liens
- Spécialisation ou classes de sortie
- Glossaire
- Réutilisation du contenu
Une évaluation se concentre sur le rendu du contenu, et non sur l’application des règles de rédaction DITA
Pratiquement tous les éditeurs de contenu DITA voient leur contenu révisé par des experts techniques qui vérifient que le contenu publié est exact et complet. Cette évaluation est souvent réalisée à l’aide d’un processus collaboratif en ligne à partir d’un résultat rendu.
Cependant, peu d’éditeurs ont mis en place une évaluation qui porte sur la manière dont le contenu est concrètement créé et sur le fait de savoir s’il est conforme aux règles. Cette situation n’est pas due à un manque d’outils, qui sont capables de réaliser différents contrôles automatisés, des règles Schematron très simples aux environnements plus contrôlés. Une autre option est l’évaluation par les pairs, qui reste cependant peu mise en œuvre.
La revue de code par les pairs est une pratique courante dans le secteur du logiciel
Par analogie, dans le secteur du logiciel, en plus des tests de fonctionnalité approfondis, chaque entreprise procède à une revue de code par les pairs reposant sur des outils technologiques. Wikipédia propose la définition suivante :
La revue de code (parfois désignée par le terme « évaluation par les pairs ») est une activité d’assurance qualité des logiciels dans le cadre de laquelle une ou plusieurs personnes vérifient un programme principalement en examinant et en lisant des parties de son code source (…)
Les revues de code sont généralement effectuées pour atteindre plusieurs objectifs :
– Amélioration de la qualité du code : améliorer la qualité du code interne et simplifier sa mise à jour (lisibilité, uniformité, compréhensibilité) […],
– Apprentissage/Transfert de connaissances […],
– Renforcement du sens de la responsabilité mutuelle […],
– Recherche de meilleures solutions […],
– Il semble que cela puisse également s’appliquer au développement de contenu DITA.
L’évaluation DITA par les pairs est un excellent moyen d’améliorer la qualité de votre contenu
Nous recommandons de mettre en place un processus d’assurance qualité pour le contenu DITA, qui inclut une évaluation du contenu par les pairs afin d’améliorer :
- Les guides de style et la terminologie
- La cohérence du contenu
- La réutilisation
- La maintenance du contenu
Intégrez votre partenaire de localisation dans le processus d’assurance qualité (AQ)
L’évaluation par les pairs que vous conduisez en interne aura un impact positif sur la qualité de votre contenu localisé. Notez que votre prestataire de services en localisation ou votre traducteur examine en détail votre contenu DITA ; leurs observations peuvent faire partie de l’évaluation par les pairs et contribuer à améliorer vos pratiques. S’ils ne vous fournissent jamais de retour sur votre contenu, soit votre contenu est parfait (bien joué ! :-)), soit vous devez remettre en question l’expertise ou le professionnalisme de votre prestataire de service en localisation.
Cet article a été écrit en anglais et traduit par Meryem MURAT, étudiante en master TSM à l’université de Grenoble, dans le cadre d’une collaboration avec les universités et avec l’aimable autorisation de Dominique Trouche.
