AP NF29 A2011 - Rapport d'étude

Voici un thésaurus réalisé lors de la première phase d'analyse afin de fixer les termes importants relatifs à la DITA.

Un concept permet d'exprimer une connaissance à mobiliser. La racine du fichier XML d'un concept est un élément concept et son corps est un élément conbody.

Est-un :Topic

Partie-de : Map, DITA

Darwin Information Typing Architecture.

Il s'agit d'une architecture pour la création de documentation technique basée sur XML. (standard XML public depuis 2001, standard OASIS depuis 2005)

DITA repose sur la notion de topic qui correspond à la granularité idéale pour permettre la réutilisation sans compromettre l'efficacité de l'auteur. Il convient donc a une production de contenus morcelés.

Utilisation :

• Pour décrire un ensemble complexe de topics.

• Pour les applications qui nécessitent de l'extensibilité et de l'interopérabilité.

Est-un : Architecture

Partie-de : Documentation technique

DocBook est un langage à balise permettant de créer de la documentation technique par une approche narrative et continue, pour ainsi décrire un travail de manière détaillée.

C'est à la fois un format SGML et XML, et depuis la version 5.0 DocBook a également été porté en XML Schema et Relax NG.

Partie-de : Documentation technique

Document comportant de l'information relative à un processus technique ou un produit, créé pour des utilisateurs ciblés (concernés par le processus ou utilisant le produit) au travers d'un média. L'information doit être particulièrement pertinente pour le lecteur.

DITA et DocBook sont des langages XML spécialisés dans la réalisation de documentations techniques.

Une map DITA est un assemblage de différentes références de topic (topicrefs) pour une publication donnée (aide en ligne, manuel d'utilisation papier, etc.).

Les topics peuvent être organisés sous forme de liste ou de façon hiérarchique (topicrefs imbriqués). Un document DITA peut contenir plusieurs map, et une map peut contenir d'autres map.

Partie-de :DITA

Les métadonnées sont des données servant à décrire un document (auteur, date, ...) ou de l'information au sein d'un document.

DITA permet de spécifier des métadonnées au niveau d'un topic ou d'une map. Si on en définit dans les 2 alors ce sont celles de la map qui compteront.

Partie-de :DITA

Une reference donne des informations relatives à un langage de programmation ou les faits à propos d'un produit (focus sur les propriétés et les relations entre items similaires). Par exemple des fonctions ou des commandes. De la même manière que les autres types de topic une reference comporte un titre, le plus souvent une courte description et un corps qui est un élément refbody. Ce dernier peut en particulier contenir un élément refsyn qui est une section spéciale pour la syntaxe ou la signature d'un contenu.

Est-un : Topic

Partie-de : Map,DITA

Processus par lequel de nouvelles entités sont créées en se basant sur des entités déjà existantes, ce qui permet aux nouvelles entités d'être gérées par les fonctions déjà existantes, et qui se caractérise par l'héritage (les nouvelles entités étant plus restrictives que les entités déjà existantes). La spécialisation permet de définir de nouveaux types d'information en réutilisant aux maximum les structures existantes. Il existe 2 types de spécialisation : la spécialisation de type et la spécialisation de domaine.

La spécialisation de domaine correspond à la création de nouveau domaine d'information. Contrairement à la spécialisation de type, la spécialisation de domaine s'applique à des éléments qui se trouvent au sein d'une map ou d'un topic. Par exemple on pourra spécialiser un élément existant au sein d'un topic et créer un specializedParagraph qui corresponde à notre domaine d'activité à partir d'un p. L'élément spécialisé ne pourra alors apparaître que là où l'élément déjà existant était autorisé. (comme p est autorisé dans un conbody, dans l'example d'un conbody et dans le postreq d'un taskbody -entre autre- il en sera de même pour specializedParagraph).

Il existe 4 spécialisations de domaine de base : highlight, programming, software et user interface qui ajoutent de la sémantique aux éléments existant dans les topics et map de base.

Est-un :Spécialisation

Une spécialisation de type correspond à la dérivation des types DITA standards (avec map ou topic en racine) pour des besoins spécifiques d'une organisation (formats de travail). Pour garantir l'échange de contenus entre deux organisations ayant des formats de travail différents, chaque type spécialisé est considéré comme le type général (commun aux deux organisations) le plus proche : il s'agit du polymorphisme.

Est-un : Spécialisation

Une task définit les moyens de réaliser une tâche précise. La racine du fichier XML d'une task est un élément "task" et son corps est un élément "taskbody". Ce dernier contient les éléments "context" (contexte de la tâche), "prereq" (le pré-requis de la tâche), "steps" (élément constitué de plusieurs "step" - étape de la tâche) et "result" (résultat final de la tâche).

Synonymes : Tâche

Est-un : Topic

Partie-de : Map, DITA

Un topic est un ensemble d'informations relevant d'un même thème (ou sujet). Il peut être réutilisé et son contenu doit être signifiant par lui-même et ce indépendamment du contexte d'utilisation (de la map dans laquelle il est utilisé). Un topic possède trois éléments obligatoires : un identifiant (id), un titre (title) et un corps (body). Concrètement il s'agit donc d'un titre suivit de texte ou d'images, éventuellement organisé en sections. Enfin, un ensemble de liens vers d'autres topics (related-links) peut être ajouté au topic. DITA fournit trois types standards qui spécialisent le type topic : concept, task, et reference.

Synonymes : Sujet, Thème

Est-un : Fragment

Partie-de : Map, DITA