Identifier le type d'information
Les concepts, les tâches et les références contiennent différents types de contenu. Les concepts contiennent des explications, les tâches des procédures et les références de l'information présentée sous forme de tableaux.
Un rédacteur travaillant dans un environnement DITA doit savoir typer l'information correctement.
Parmi les trois types d'information de base dans DITA :
- Les concepts servent à donner un aperçu d'une tâche ou d'une référence. Ils ont tendance à être simples et concis.
- Les tâches décrivent des procédures.
- Les références décrivent des propriétés et autres informations de référence (par opposition aux informations narratives), le plus souvent sous forme de tableaux.
Systèmes d'alarme
(concept)Configurer l'alarme
(tâche)Codes d'alarme
(référence)
Un ensemble de rubriques doit être associé à l'aide d'une table de relations reltable, de sorte que les rubriques soient liées entre elles ou associées dans le document livrable. Une procédure typique nécessite la rédaction d'une rubrique concept et d'une rubrique tâche, et éventuellement d'une rubrique référence.
Alors que les informations relatives aux tâches sont généralement faciles à identifier, il est revanche parfois difficile de distinguer des informations relatives à un concept et à une référence. La section Caractéristiques des rubriques concept et référence présente certaines caractéristiques en comparant concepts et références.
Concept | Référence | |
---|---|---|
But et fonction |
explications |
faits |
Fréquence de lecture |
à quelques reprises |
à plusieurs reprises, si besoin |
Place dans l'ouvrage |
début et/ou milieu |
fin |
Contenu ou données |
contenu |
données |