Commençons une définition : DITA est l’abréviation de « Darwin Information Typing Architecture », d’où l’acronyme. D’un point de vue plus pratique, DITA est une norme XML ouverte qui est conçue pour transmettre des informations en « morceaux », appelés sujets (articles, topics), qui sont assemblés au niveau d’un document à l’aide de « cartes » (une table des matières). Il est alors possible de produire du contenu dans divers formats, notamment HTML et PDF. Ces dernières années, DITA XML est devenu un moyen populaire que de nombreuses entreprises utilisent pour répondre plus efficacement à leurs besoins en matière de documentation. Comme toutes les formes d’écriture structurée, il nécessite une approche et un processus de réflexion différents de la part du rédacteur par rapport à un document « ordinaire » écrit de manière linéaire.

L’historique de DITA sera abordé dans un autre post, mais si vous êtes rédacteur technique ou responsable de rédacteurs techniques et que vous souhaitez passer de votre processus actuel à DITA, vous êtes au bon endroit.

« Rédiger en DITA » est très différent d’une écriture linéaire ou monolithique. Comme il s’agit de XML, écrire en DITA signifie que vous devez penser et écrire de manière structurée. L’un des meilleurs exemples auxquels se référer concerne la manière de traiter des tâches du quotidien. On se focalise sur un sujet, on le segmente et on le traite.

Ce qui suit est basé sur quelques exemples bruts réels que nous avons traités (et ensuite restructurer). Un sujet de rédaction non structuré peut débuter par quelques étapes, puis ajouter une explication, éventuellement quelques étapes supplémentaires, parler d’un autre processus qui doit être envisagé, puis inclure les quelques étapes restantes pour compléter le sujet.
Ensuite, mentionnez l’élément d’information essentiel que vous deviez connaître dès le départ et qui vous aurait permis de savoir si vous deviez effectuer cette tâche en premier lieu.

D’accord, cela peut paraître idiot

D’accord, cela peut paraître idiot, et pourtant souvent nous avons constaté cette forme de processus de réflexion. Ce genre d’approche reflète les processus de pensée linéaires de l’auteur, qui commence par quelques étapes, se rend compte qu’il faut un peu de contexte, ajoute d’autres étapes, se rend compte que dans un cas légèrement différent, il faudrait faire autre chose, puis ajoute les étapes restantes. Il réalise ensuite qu’il suffit de faire toute cette procédure dans une circonstance spécifique, qui est précisée à la fin.

C’est un exemple extrême, mais qui n’est pas rare selon notre expérience. L’une des choses qu’une approche structurée de l’écriture enseigne au rédacteur est d’organiser toutes ces informations de manière à présenter les informations de sorte que l’utilisateur final aie toutes les cartes en main au moment où il en a besoin.
Ainsi, une approche structurée fournira d’abord un contexte sur le « comment » et le « pourquoi » de la procédure, établira des liens avec des informations ou des procédures similaires mais connexes, puis dressera une liste séquentielle des étapes, en insérant des « notes » pour fournir un contexte supplémentaire si nécessaire.

Le fauve est libéré de sa cage

Si un changement significatif intervient à la fin de la procédure (par exemple, l’interface graphique change pour une nouvelle fenêtre, la machine est mise hors tension, le fauve est libéré de sa cage, etc. ), le rédacteur peut ajouter le résultat escompté à la fin de la procédure. Au final, vous obtenez un sujet condensé qui transmet toutes les informations qu’un utilisateur doit connaître sur cette procédure particulière. Le sujet est « autonome » et peut être présenté dans une brochure indépendante ou un « grand manuel », selon les besoins.

Nous arrivons donc à l’un des principaux avantages de la rédaction structurée en généra

Nous arrivons donc à l’un des principaux avantages de la rédaction structurée en général, qui est la réutilisation : en concevant une procédure autonome pour une situation donnée, vous la pérennisez automatiquement pour la réutiliser dans d’autres documents. Lorsqu’elle est bien faite, elle réduit la corvée du rédacteur (ou plus probablement d’un autre rédacteur) qui doit réécrire la même procédure, avec l’avantage supplémentaire d’une productivité accrue (ce qui est une chose que les responsables de la rédaction technique aiment).

La réutilisation est l’un des piliers du retour sur investissement (ROI) habituel pour passer d’une approche d’écriture non structurée DITA. La réutilisation est implicite avec DITA, même si en tirer le meilleur parti est un défi différent (qui implique souvent, mais pas toujours, un système de gestion de contenu (CMS)).