DITA XML est une norme de rédaction structurée dédiée à la création de documentations techniques. Que vous soyez en charge de la documentation produit, des contenus de formation, des guides de démarrage rapide ou des tutoriels, DITA XML peut considérablement améliorer la qualité de vos contenus tout en offrant la meilleure expérience possible à vos utilisateurs.
Cependant, apprendre à créer du contenu avec DITA XML est une compétence à acquérir et à développer. Produire une documentation technique de haute qualité, ça se mérite ! Voici les étapes à suivre impérativement pour créer vos premiers contenus avec DITA XML et devenir un expert en la matière.
Découvrez l’environnement de la norme DITA XML
DITA XML est une norme spécifique, qui place l’utilisateur au cœur du processus de rédaction. Vous devez commencer par en comprendre les bases avant d’aller plus en profondeur.
L’enjeu est d’identifier les différents types d’éléments DITA, comment ils sont utilisés et comment ils sont correctement structurés. De nombreuses ressources sont disponibles pour vous guider dans votre apprentissage de la norme DITA XML, notamment les cours Apprendre DITA, la communauté DITA XML ou encore un glossaire des termes spécifiques.
Une fois que vous aurez acquis les bases de la norme DITA XML, vous pourrez découvrir comment l’appliquer à vos projets de rédaction technique :
- Création d’une DITA Map
- Choix des topics
- Architecture du contenu
- Gestion des révision(s)
- Application de votre charte graphique
- Publication vers un format de sortie
Vous familiariser avec la norme avant de commencer à rédiger du contenu est primordial. Cela vous permet de mieux comprendre les étapes suivantes, d’établir un flux de travail adapté et de créer une documentation bien structurée.
Équipez-vous des outils nécessaires pour DITA XML
Après avoir acquis les connaissances de base de la norme DITA XML, équipez-vous des outils nécessaires à la création et à la gestion du contenu technique. Voici les outils les plus utilisés :
- Oxygen XML Editor: un éditeur XML très polyvalent, qui supporte DITA et offre une bonne couverture de toutes les technologies XML.
- DITA-OT (DITA Open Toolkit): une boîte à outils gratuite et open-source utilisée pour publier du contenu avec DITA XML.
- DITA CCMS (Component Content Management System): vous pouvez également choisir de travailler avec un CCMS DITA, qui offre une plus large gamme de possibilités pour la rédaction de contenu et DITA XML. Les outils CCMS sont un choix stratégique pour les projets collaboratifs qui impliquent plusieurs rédacteurs, réviseurs,traducteurs ou tout autre contributeur externe.
Componize est un CCMS ultra-complet grâce auquel vous pouvez créer, gérer, traduire, réviser et publier votre contenu DITA XML. Componize gère la création de votre contenu DITA XML de A à Z, intègre un connecteur avec des outils d’édition tels qu’Oxygen ou Fonto, et dispose de la dernière version de DITA Open Toolkit. C’est la meilleure solution pour centraliser tous les outils et les fonctionnalités dont vous avez besoin pour exploiter la norme DITA XML à son plein potentiel. Découvrez toutes nos fonctionnalités ici !
Configurez votre répertoire de contenu DITA XML
Le répertoire centralise et gère tous vos topics et éléments DITA XML. Vous pouvez les stocker sur un disque local ou dans un fichier en ligne. Les outils CMS et CCMS* permettent également de centraliser votre contenu DITA XML. Le plus important est de vous assurer que votre répertoire est correctement structuré et de définir un espace de stockage qui vous convient, suivant les outils que vous utilisez.
Le répertoire conserve tous les éléments de votre contenu, tels que la Map, les topics, les reuse, les images et la DITAVAL.
*Les outils CMS (Content Management Software) et CCMS sont différents. Le CMS est un outil de gestion de contenu qui prend principalement en charge des formats non structurés. Le CCMS est spécialement conçu pour la gestion du contenu structuré et DITA : il s’intéresse aux composants, au partage, à la réutilisation et à la publication vers différents formats.
Créez une stratégie de contenu solide et efficace
Une stratégie de contenu solide est indispensable pour la création de contenus DITA XML. Cette stratégie doit tenir compte de votre public cible, de vos objectifs, de vos thématiques et de l’architecture envisagée. DITA XML vous permet de créer une multitude de contenus différents.
Cibler votre public est probablement l’aspect le plus important. Fixez-vous des objectifs clairs pour votre stratégie et organisez votre contenu de manière à ce qu’il soit facilement accessible et compréhensible par votre audience. Utilisez un style et un ton homogènes tout au long de votre rédaction.
Ces questions peuvent orienter vos choix en matière de stratégie de contenu :
- Quels sont les sujets les plus importants pour votre public cible ?
- Comment organiser votre contenu pour qu’il soit accessible ?
- Quel ton ou style devez-vous employer ?
- Comment mesurer l’impact de votre stratégie ?
Communiquer correctement est indispensable pour les utilisateurs. En rédaction technique, le minimalisme est de rigueur. Ce type de communication permet de transmettre l’information rapidement, de manière transparente et précise à votre audience.
Appliquez le balisage DITA XML à la perfection
La norme DITA impose un système de balises propre à la communication technique. La création de contenu DITA XML est basée sur plusieurs règles d’architecture et d’imbrication de balises XML que vous devez donc respecter.
Chaque projet créé avec DITA comporte des topics, les 3 principaux sont :
- concept : pour décrire un produit ou bien une fonctionnalité.
- task : pour donner des instructions étape par étape.
- reference : pour lister une ou plusieurs séries de données et de références techniques.
Chaque topic se rapporte à un type d’information et présente des critères précis concernant l’architecture XML.
Les CCMS et les outils d’édition comprennent un système de régulation des balises. Vous ne pouvez pas publier votre documentation tant qu’elle n’est pas conforme à la norme, ce qui facilite grandement l’application de DITA !
L’avant publication : une étape cruciale pour votre contenu DITA XML
Produire de la documentation ne se limite pas à DITA XML et à la rédaction. La révision, la personnalisation et la transformation sont nécessaires pour garantir la qualité et la pertinence de votre documentation.
La révision du contenu
La révision est essentielle pour des raisons de qualité. Votre contenu doit être clair, concis, précis et facile à comprendre pour garantir un accès fluide à l’information.
Vous pouvez solliciter d’autres rédacteurs techniques, des experts DITA XML ou tout autre ressource qualifiée pour réviser votre contenu et vous transmettre des retours pertinents. C’est pourquoi l’utilisation d’un outil dédié à la collaboration DITA est primordiale : vos collaborateurs (internes ou externes) peuvent réviser le contenu, centraliser les connaissances au sein d’un seul et même outil et faciliter le processus de traduction.
La révision est une étape clé. Vous pouvez définir à l’avance une charte d’assurance qualité pour vous assurer que votre contenu DITA XML répond aux attentes de votre public, ainsi qu’aux exigences des normes et des spécifications de votre secteur.
Personnalisez la mise en page et le formatage de votre document
La création, la rédaction et l’édition jouent un rôle majeur dans l’expérience utilisateur. Mais le caractère visuel de la documentation est tout aussi important.
Vous pouvez ajouter une feuille de style (CSS ou XSL-T) pour personnaliser la documentation avec votre charte graphique. Liez cette feuille de style à votre DITA Map pour appliquer vos paramètres de style et de formatage à l’ensemble de votre documentation rapidement, de façon homogène et cohérente.
Sélectionnez le bon format de sortie
La dernière étape consiste à choisir le format de sortie de la documentation, aussi appelée « transformation ». En d’autres termes, la documentation est prête à être publiée et elle est convertie vers un autre format :
- HTML
- Web Help
- XHTML
- etc.
Le choix du format de sortie dépend de plusieurs facteurs, tels que le référencement et l’indexation Web, l’impression ou le déploiement sur une autre plateforme. Vous pouvez bien sûr sélectionner plusieurs formats de sortie pour une même documentation.
Conclusion
Se lancer dans la rédaction DITA XML, c’est ouvrir la porte à une gestion de contenu plus structurée, plus flexible et plus efficace. De la compréhension des bases de DITA à la mise en place d’une stratégie de contenu solide, chaque étape est clé pour garantir la qualité et la cohérence de vos documents techniques.
Grâce à DITA XML, vous pouvez optimiser votre flux de travail, garantir une réutilisation maximale de votre contenu et offrir une documentation claire, précise et facilement accessible à vos utilisateurs. Vous êtes désormais armé pour débuter, mais aussi pour perfectionner vos compétences et tirer le meilleur parti de cette norme puissante.
