Conserver et structurer votre contenu réutilisable en marge de votre documentation
Pour éviter la documentation « spaghetti », conservez tout votre contenu réutilisable dans des rubriques prévues à cet effet rangées dans des dossiers leur étant consacrés.
Organisez ces rubriques dans des cartes DITA, puis ajoutez-les dans d’autres cartes DITA avec l’attribut <mapref processing-role= »resource-only »>.
Se mettre d’accord sur des conventions de dénomination pour les fichiers et les id
Bien que les applications de rédaction DITA assignent automatiquement un id aux éléments potentiellement réutilisables, il reste préférable que les ids donnés soient intelligibles pour les rédacteurs. Il faut néanmoins prendre conscience de l’augmentation des risques de confusion des ids. Deux stratégies existent pour réduire les risques.
- Créer des conventions de dénominations pour les ids afin de réduire les chances de confusions.
- Tenir un registre de toutes les ids afin d’aider les rédacteurs à trouver des doublons. Ce registre peut être un simple tableau ou un document texte, mais il peut aussi être bien plus complexe si nécessaire.
- Ajouter une carte DITA à votre dossier consacré à la réutilisation de contenu. Ajouter tous vos éléments réutilisable dans cette carte. Le validateur signalera toutes les ids dupliqués. Réaliser cette procédure avant de publier votre contenu sur votre plateforme.
S’assurer que les rubriques et les éléments soient réutilisables
Comme il a été expliqué dans la leçon, le référencement de contenu qui semble fonctionner en français ne l’est peut-être pas dans une autre langue, ce qui peut poser des problèmes lors de la traduction du contenu.
- Ne pas utiliser de conref associé à l’élément <ph> pour remplacer des fragments de phrase.
- Être prudent lors du référencement d’une phrase entière.
- Réutiliser des blocs de contenus répondant aux conditions suivantes :
-
Le contenu réutilisé doit être grammaticalement indépendant.
-
Les éléments référencés et les éléments référençants doivent partager le même contexte.
-
La communication est la clef
Avant d’apporter des modifications aux rubriques pour la réutilisation de contenu, assurez-vous de savoir quelles sont les rubriques qui utilisent les contenus conservés. Certains CMS comprennent des outils pour retrouver toutes les rubriques et les cartes référencées. Si vous possedez ces outils, utilisez-les.
Invitez toutes les parties prenantes à s’exprimer avant de décider de modifier le contenu partagé. Il se peut qu’afin de satisfaire tous les partenaires, il sera nécessaire de créer plusieurs versions du même contenu. Il est préférable d’éviter les situations où les structures de partage de contenu sont rendues inutilisables, voire entraînent la création de contenu erroné.
Practice
- Ouvrez le fichier exemples_reutilisation/conrefs/t_observer_canards_sauvages_debut.dita.
- Après le premier paragraphe sur les prérequis (prerequisities), ajoutez un conref du paragraphe présent dans le fichier exemples_reutilisation/conrefs/c_securite_canard.dita.
- Comparez votre travail avec le fichier exemples_reutilisation/conrefs/t_observer_canards_sauvages.dita.
Contributors
- Mike Rice, easyDITA
- Annie Chen, easyDITA
- Decarnelle Rémi (traducteur)