Bien rédiger les titres de rubriques

Rédiger des titres de rubriques précis, concis et cohérents représente un défi majeur pour les rédacteurs utilisant DITA. Des directives pour la rédaction des titres existent pour vous faciliter la tâche.

Pour rédiger sous forme de rubriques, les segments d'information doivent être autonomes. Ils doivent pouvoir être lus de manière indépendante, sans lien avec ce qui les précède ou ce qui les suit. Une rubrique ayant un en-tête Présentation ne peut être autonome, car son contenu n'est pas suffisamment détaillé. Présentation de la Supara Liberty est un libellé plus adapté.

La place capitale des titres dans les environnements de rédaction sémantique et structurée suppose la création de libellés (et autres formes de classification) précis. Aussi, l'élaboration de titres clairs demande du temps et des compétences.

En plus d'aider le lecteur à comprendre l'objet d'une rubrique, le titre doit l'aider à identifier le type de cette rubrique. D'après son titre, les lecteurs doivent savoir si la rubrique peut les aider à comprendre quelque chose, les aider à faire quelque chose ou leur fournir un complément d'informations. Pour cela, les titres des rubriques doivent être formulés de manière distincte en fonction des différents types d'information.

Ils doivent être clairs, faciles à lire, précis, concis et cohérents.

Lorsque vous rédigez des titres, essayez de les construire comme des fragments de phrase. Réécrire le titre après avoir rédigé le contenu de la rubrique et de la courte description (shortdesc) constitue une bonne technique.

Voici quelques directives plus précises  :
  • Évitez d'utiliser des articles définis (par exemple, le) ou indéfinis (par exemple, un) : écrivez Moteur et non Le moteur.
  • Utilisez le singulier et non le pluriel : écrivez Moteur et non Moteurs.
  • Évitez de commencer les titres par des expressions généralisées : écrivez Sécurité ou Maintenance et non À propos de la sécurité ou Introduction à la maintenance.
  • Évitez d'utiliser l'esperluette : écrivez Contrôles et commutateurs et non Contrôles & commutateurs.
  • Préférez l'infinitif aux substantifs : écrivez Démarrer le moteur et non Démarrage du moteur.
  • Évitez d'utiliser des sauts de ligne.
  • Utilisez des termes simples.
  • Évitez les titres de plus de huit mots.
  • Mettez la première lettre en majuscule.
  • Utilisez des qualificatifs pour rendre les titres plus précis : écrivez Réduire la longueur du rapport et non Longueur du rapport, écrivez Avantages des moteurs à induction forcée et non Induction forcée).
  • Assurez-vous que les titres peuvent être compris hors contexte.
  • Utilisez une syntaxe cohérente et des constructions parallèles.
Pour que les titres permettent au lecteur d'identifier les types d'information, suivez les directives ci-dessous.
Type d'information Syntaxe Exemples
Concept Commencez par un nom ou un adjectif Fenêtre client, Caractéristiques de la Supara Liberty, Paramètres importants pour les modifications du moteur
Tâche Commencez par un infinitif et utilisez des noms singuliers Réinitialiser l'odomètre, Imprimer le rapport d'audit
Référence Commencez par un nom ou un adjectif et incluez le concept de référence (par exemple, tableau, liste, etc.) Tableau des spécifications, Liste des codes produit