Concept, tâche, référence : trois types de contenu de documentation technique
Un des aspects clés de la rédaction technique est une organisation efficace, ce qui améliore non seulement la qualité du contenu et sa facilité d’utilisation, mais le rend aussi plus simple à réviser et à réutiliser. Une méthode courante d’organisation du contenu est DITA (Darwin Information Typing Architecture soit Architecture darwinienne de typage d’information) : une approche modulaire de création de contenu qui met l’accent sur la rédaction basée sur des rubriques.
Dans la rédaction basée sur des rubriques, le contenu est divisé en plusieurs rubriques qui portent sur des sujets individuels. Dans cet article, nous nous intéresserons au cadre de typage d’information DITA, qui implique de classer les sujets dans l’une des trois catégories suivantes : concept, tâche ou référence.
- Une rubrique de concept donne une explication générale d’un sujet.
- Une rubrique de tâche donne des instructions pour exécuter une tâche.
- Une rubrique de référence donne des données ou des faits précis.
L’architecture DITA requiert d’abord de déterminer quel genre d’information vous devez présenter au lecteur, puis de l’organiser en diverses rubriques. La plupart des documentations techniques utilisent les trois types de rubriques.
La façon dont vous utilisez le typage d’information varie selon la taille de la documentation. Les documents plus longs comprennent généralement un grand nombre de rubriques de chaque type d’information et ne sont pas nécessairement organisés de la même façon que les documents plus courts, qui eux peuvent contenir seulement une ou deux rubriques de chaque type d’information.
Disons, par exemple, que vous rédigez un guide pour l’utilisation de l’imprimante 3D d’une bibliothèque. Vous pourriez utiliser les trois types d’information comme suit, selon que vous rédigez un document long ou un document court :
| Type d’information | Guide de démarrage rapide (document court) | Guide d’utilisation (document long) |
| Concept |
|
|
| Référence |
|
|
| Tâche |
|
|
En organisant ces rubriques par types, vous aidez le lecteur à utiliser votre contenu plus efficacement. Idéalement, chaque rubrique a son propre titre dans le document.
Écrire des rubriques de concept, de référence et de tâche
Quand vous rédigez des rubriques, utilisez une structure et un formatage différents pour les différents types de rubriques. Cela rendra votre contenu plus facile à lire et à comprendre.
Écrire les titres des rubriques
Utilisez des titres de rubriques semblables pour les différents types d’information, comme le montre le tableau ci-dessous :
| Concept | Référence | Tâche | |
| Commence par | Nom ou groupe du nom | Nom | Verbe à l’infinitif |
| Exemple | “Services d’imprimante 3D à la bibliothèque” | “Coûts des impressions 3D” | “Utiliser une imprimante” |
Structurer les rubriques
Pour les rubriques de concepts, utilisez des phrases complètes et des paragraphes. Comme vous donnez un aperçu ou une explication, favorisez les paragraphes courts. C’est généralement une bonne façon de susciter l’implication du lecteur.
Pour les rubriques de tâches, utilisez des listes ordonnées. Chaque étape décrit généralement une action et les étapes sont présentées dans l’ordre dans lequel le lecteur doit les exécuter.
Pour les rubriques de références, servez-vous de tableaux ou de listes. Utilisez des tableaux pour afficher les spécifications de produits de plusieurs produits ou scénarios, et des listes pour établir la terminologie ou indiquer les fournitures requises.
Mettre les rubriques en ordre
Organiser votre contenu de façon cohérente aidera le lecteur à deviner où il pourra trouver l’information dont il a besoin, même s’il lit le contenu dans le désordre.
Quand vous structurez un document, utilisez une rubrique de concept en guise d’introduction – elle explique pourquoi le document existe, à qui elle s’adresse et qu’est-ce que le lecteur peut s’attendre à trouver dans les rubriques de tâches et de références associées. Selon le sujet, la section suivante peut être une rubrique de tâche ou de référence.
Vous devez prendre en compte le sujet de la rubrique, en plus de son type d’information, quand vous organisez les rubriques. Dans le cas de documents plus longs, une méthode efficace consiste à regrouper les rubriques par sujets, puis à les organiser par concept-tâche-référence (dans cet ordre ou dans un autre ordre) à l’intérieur d’un sujet.
Quelques réflexions
Le cadre DITA vous aide à créer du meilleur contenu technique. Du point de vue du rédacteur, DITA aide à créer du contenu facile à réutiliser et à réorganiser, ce qui permet de gagner du temps et d’améliorer la cohérence. Du point de vue du lecteur, il est plus facile de naviguer dans le contenu, et donc de l’utiliser. Avec DITA, vous réussirez à créer du contenu technique de qualité supérieure et en moins de temps.
