La courbe d\u2019apprentissage d\u00e9pend bien s\u00fbr de l\u2019exp\u00e9rience de chaque individu, de la compr\u00e9hension approfondie des concepts, et du savoir-faire. Toutefois, trois aspects sont essentiels pour tout un chacun, ind\u00e9pendamment de l\u2019exp\u00e9rience.<\/p>\n\n\n\n
- Renforcement des bonnes pratiques <\/em>\u2013 des pratiques parfois utilis\u00e9es inconsciemment, \u00e0 renforcer ; mais aussi des connaissances famili\u00e8res \u00e0 appliquer autrement.<\/li>
- Adoption de nouvelles pratiques <\/em>\u2013 de nouvelles pratiques li\u00e9es aux responsabilit\u00e9s \u00e9largies notamment gr\u00e2ce \u00e0 la r\u00e9daction structur\u00e9e et modulaire mais aussi \u00e0 la publication vers de nouveaux formats.<\/li>
- Laisser tomber des habitudes <\/em>\u2013 cela peut \u00eatre contre-intuitif, mais laisser tomber certaines pratiques li\u00e9es \u00e0 des outils ou \u00e0 des formats propri\u00e9taires est parfois le plus difficile pour les r\u00e9dacteurs.<\/li><\/ul>\n\n\n\n
Les formateurs et les apprenants peuvent utiliser ces aspects pour \u00e9valuer les exigences de formation de chaque groupe. Cet article va parler du premier de ces aspects : Renforcement des bonnes pratiques.<\/em><\/p>\n\n\n\n
Pour d\u00e9marrer avec DITA<\/span><\/h2>\n\n\n\n
La plupart des r\u00e9dacteurs connaissent d\u00e9j\u00e0 les mod\u00e8les, les structures, les styles, la cat\u00e9gorisation, l\u2019identification de document (nomenclatures), et la cr\u00e9ation de r\u00e9sum\u00e9s. DITA, standard international ouvert, rend ces aspects essentiels et dans une certaine mesure, contraint les r\u00e9dacteurs techniques. La cl\u00e9 pour comprendre la r\u00e9daction modulaire (ou la r\u00e9daction en rubrique) n\u00e9cessite que les r\u00e9dacteurs techniques :<\/p>\n\n\n\n
- Choisissent clairement quel type d\u2019information1<\/sup><\/a> ils veulent r\u00e9diger.<\/li>
- Utilisent des balises plut\u00f4t que des styles pour clarifier le sens des segments de texte.<\/li>
- Enrichissent les contenus avec des m\u00e9tadonn\u00e9es qui permettent d\u2019identifier non seulement tout le livrable, mais aussi chaque fragment (pensez \u00e0 l\u2019indexation).<\/li><\/ul>\n\n\n\n
Comprendre le typage des rubriques<\/span><\/h2>\n\n\n\n
La r\u00e9daction modulaire devrait \u00eatre plus facile \u00e0 mettre en \u0153uvre pour les r\u00e9dacteurs qui ont une bonne connaisse des normes et pratiques suivantes : <\/p>\n\n\n\n
- Norme transverse ISO-IEC-IEEE 82079-1 2019 Pr\u00e9paration de l\u2019information pour les instructions de produits \u2014 Partie 1 : Principes et exigences g\u00e9n\u00e9rales<\/em>, qui s\u00e9pare les contenus en informations proc\u00e9durales (instructions), information conceptuelle, et information de r\u00e9f\u00e9rence.<\/li>
- Anglais simplifi\u00e9 (Simplified Technical English) \u2013 qui s\u00e9pare les contenus en informations proc\u00e9durales, information conceptuelle.<\/li>
- Information mapping\u00ae, qui s\u00e9pare les contenus en informations proc\u00e9durales, processus, descriptions\u2026<\/li>
- Les mod\u00e8les et les patterns communs sur le Web (iFixIt, HowTo\u2026) qui fournissent des structures \u00e0 l\u2019information proc\u00e9durale.<\/li><\/ul>\n\n\n\n
Lorsque le type de contenu est \u00e9tabli, le r\u00e9dacteur suit la structure d\u2019information (le mod\u00e8le) attendue selon ce type. La structure est largement bas\u00e9e sur le sens commun et les bonnes pratiques de l\u2019industrie de la communication technique. <\/p>\n\n\n\n
Baliser plut\u00f4t que de mettre en forme pour ajouter du sens aux fragments de texte<\/span><\/h2>\n\n\n\n
Le XML, comme le HTML, est un langage balis\u00e9. Cela implique que le texte peut \u00eatre enrichi avec de l\u2019information \u00e0 valeur ajout\u00e9e. La plupart des r\u00e9dacteurs ne r\u00e9digeront pas eux-m\u00eames, manuellement, ces \u00e9l\u00e9ments. Les mod\u00e8les de rubriques et les interfaces des \u00e9diteurs, avec des actions cliquables, permettent aux r\u00e9dacteurs de choisir et d\u2019appliquer les bonnes balises facilement.<\/p>\n\n\n\n
La plupart des r\u00e9dacteurs, dans un contexte non structur\u00e9, utilisent des styles bien d\u00e9finis pour donner du sens au texte et assigner un objectif \u00e0 l\u2019information. Ainsi, une citation sera pr\u00e9sent\u00e9e en italique alors qu\u2019en r\u00e9daction DITA, les r\u00e9dacteurs choisiront une balise <\/cite> (ou
<\/longquoteref>).<\/p>\n\n\n\n Autre exemple, dans l\u2019architecture des rubriques proc\u00e9durales, on peut trouver une \u00e9tape comme celle-ci : \u00c9tape 1. Cr\u00e9er une nouvelle proc\u00e9dure., qui sera pr\u00e9sent\u00e9e en XML (ou XHTML) dans un \u00e9l\u00e9ment paragraphe (p) :<\/p>\n\n\n\n
\u00c9tape 1. Cr\u00e9er une nouvelle proc\u00e9dure.<\/p><\/h6>\n\n\n\n
<\/p>\n\n\n\n
Ceci sera interpr\u00e9t\u00e9 comme un paragraphe, mais il n\u2019y a pas d\u2019indice permettant d\u2019identifier ceci comme une instruction. Le r\u00e9dacteur doit ajouter les num\u00e9ros d\u2019\u00e9tapes manuellement pour suivre le flux des instructions et doit le mettre \u00e0 jour \u00e0 chaque fois que \u00ab Cr\u00e9er une nouvelle proc\u00e9dure \u00bb est utilis\u00e9 dans un autre contexte ou une autre s\u00e9rie d\u2019\u00e9tapes. En revanche, avec DITA, on va pouvoir ajouter plus de d\u00e9tails s\u00e9mantiques, par exemple :<\/p>\n\n\n\n
Cr\u00e9er une nouvelle proc\u00e9dure.<\/cmd> <\/steps><\/step><\/step><\/steps><\/h6>\n\n\n\n <\/p>\n\n\n\n
Ceci sera interpr\u00e9t\u00e9 comme une instruction, \u00e0 l\u2019int\u00e9rieur d\u2019une \u00e9tape, faisant partie d\u2019une s\u00e9rie, et int\u00e9gr\u00e9e \u00e0 une rubrique proc\u00e9durale. Parce que la mise en forme est s\u00e9par\u00e9e du contenu, la num\u00e9rotation et le mot-cl\u00e9 \u00ab \u00c9tape \u00bb sont ajout\u00e9s automatiquement par l\u2019\u00e9diteur XML pour proposer une vue am\u00e9lior\u00e9e au r\u00e9dacteur, et inject\u00e9 au moment de la publication. <\/p>\n\n\n\n
Avec DITA, les mots-cl\u00e9s pour les avertissements de s\u00e9curit\u00e9, les notes, les l\u00e9gendages, sont ajout\u00e9s et num\u00e9rot\u00e9s automatiquement lors du processus de publication.<\/p>\n\n\n\n
Cat\u00e9goriser et libeller l’identification des produits et de l’information<\/span><\/h2>\n\n\n\n
Quelle que soit son industrie, chaque r\u00e9dacteur doit pouvoir identifier les contenus et les produits qu\u2019il documente. Ces deux aspects sont importants pour identifier tout contenu. Lors du passage \u00e0 DITA, cette information peut \u00eatre ins\u00e9r\u00e9e au niveau de chaque rubrique, ou au niveau de la collection (carte ou sous-carte par exemple). Dans la plupart des cas, la s\u00e9lection des identifiants, obligatoires ou non, et de la mani\u00e8re dont ils doivent \u00eatre transf\u00e9r\u00e9s en DITA sera prise en charge par un architecte d\u2019information ou par un expert DITA s\u00e9nior.<\/p>\n\n\n\n
Il s\u2019agit ici r\u00e9ellement de cartographier l\u2019identification actuelle, mais aussi d\u2019enrichir les rubriques avec tous les identifiants n\u00e9cessaires, lorsqu\u2019elles sont r\u00e9utilis\u00e9es dans la documentation de plusieurs produits diff\u00e9rents.<\/p>\n\n\n\n
\u00ab Les informations de libell\u00e9 et de catalogage font partie des m\u00e9tadonn\u00e9es des rubriques ou des collections. Les m\u00e9tadonn\u00e9es permettent au contenu d\u2019\u00eatre filtr\u00e9, list\u00e9, trait\u00e9 et manipul\u00e9 d\u2019autres fa\u00e7ons. Choisir des libell\u00e9s pr\u00e9cis permettra de cr\u00e9er des documents plus flexibles.<\/em>2<\/sup><\/a> \u00bb<\/h6>\n\n\n\n
<\/p>\n\n\n\n
Le r\u00e9sultat attendu est de fournir aux machines et aux processeurs les moyens d\u2019identifier le contenu et d\u2019appliquer l\u2019optimisation de la recherche, la cr\u00e9ation de facettes, et g\u00e9rer l\u2019identification des produits.<\/p>\n\n\n\n
R\u00e9diger des r\u00e9sum\u00e9s pour permettre l’identification des informations aux utilisateurs<\/span><\/h2>\n\n\n\n
La plupart des r\u00e9dacteurs ayant de l\u2019exp\u00e9rience en r\u00e9daction web ou en journalisme connaissent la technique de la pyramide invers\u00e9e. Cette technique rend le contenu plus accessible, et permet d\u2019am\u00e9liorer le r\u00e9f\u00e9rencement naturel justement car elle se conforme aux guides d\u2019accessibilit\u00e9 web.<\/p>\n\n\n\n
La pyramide invers\u00e9e se r\u00e9f\u00e8re \u00e0 la structure o\u00f9 l\u2019essentiel (voire la conclusion, selon certains) est fourni en premier. Ainsi, dans ce cas, le premier paragraphe, que l\u2019on trouve imm\u00e9diatement apr\u00e8s le titre, aide les r\u00e9dacteurs avanc\u00e9s \u00e0 se souvenir des points cl\u00e9s, et aident tous les utilisateurs \u00e0 identifier si cette rubrique particuli\u00e8re donnera la r\u00e9ponse \u00e0 la question qu\u2019ils se posent.<\/p>\n\n\n\n
Ces descriptions courtes (ou ch\u00e2po), sont difficiles \u00e0 r\u00e9aliser. Elles doivent \u00eatre courtes, se concentrer sur les points essentiels de la rubrique, mais ne sont ni une redite du titre, ni du m\u00e9tatexte.<\/p>\n\n\n\n
Exemple d\u2019une mauvaise description pour une rubrique appel\u00e9e Eco Printing :<\/p>\n\n\n\n
Les explications ci-dessous concernent les proc\u00e9dures d\u2019impression \u00e9co pour l\u2019impression \u00e9cologique.<\/em><\/h6>\n\n\n\n
<\/p>\n\n\n\n
Exemple d\u2019une description am\u00e9lior\u00e9e de la rubrique Eco Printing :<\/p>\n\n\n\n
La fonction Eco limite l\u2019utilisation du papier et du toner. La fonction Eco vous permet d\u2019\u00e9conomiser les ressources et permet une impression plus \u00e9cologique. Si vous appuyez sur le bouton Eco depuis le panneau de commande, le mode Eco est activ\u00e9. Par d\u00e9faut, le mode \u00e9co propose Plusieurs pages par c\u00f4t\u00e9 (2) et \u00c9conomie de toner.<\/em><\/h6>\n\n\n\n
<\/p>\n\n\n\n
Exemple d\u2019une bonne description de la rubrique Eco Printing :<\/p>\n\n\n\n
Utilisez la fonction Eco pour \u00e9conomiser du papier et du toner. Appuyez sur le bouton Eco du panneau de commande pour activer le mode Eco. Les param\u00e8tres par d\u00e9faut sont Plusieurs pages par c\u00f4t\u00e9 (2) et \u00c9conomie de toner.<\/em><\/h6>\n\n\n\n
<\/p>\n\n\n\n
—-
Ce blog a \u00e9t\u00e9 initialement publi\u00e9 dans la lettre d’information de CIDM, CIDM Matters<\/em><\/a><\/span>.<\/p>\n\n\n\nLes prochains articles parleront de deux autres aspects de la r\u00e9daction avec DITA : l\u2019adoption de nouvelles pratiques<\/span><\/a> et l\u2019abandon de certaines habitudes<\/a><\/span>.<\/p>\n\n\n\n
Ressources<\/h3>\n\n\n\n
Amy Schade, Inverted Pyramid: Writing for Compr\u00e9hension,<\/em> consult\u00e9 en ligne, Norman Nielsen Group: https:\/\/www.nngroup.com\/articles\/inverted-pyramid\/<\/a><\/span><\/p>\n\n\n\n
Keith Schengili-Roberts, IXIASOFT and Joe Storbeck, JANAS<\/em>, Short Descriptions Shouldn\u2019t Be a Tall Order: Writing Effective Short Descriptions<\/em>, consult\u00e9 en ligne, CIDM:\nhttps:\/\/www.infomanagementcenter.com\/product\/short-descriptions-shouldnt-be-a-tall-order-writing-effective-short-descriptions\/<\/a><\/span><\/p>\n\n\n\n
Tony Self Dr., DITA Style Guide, Best Practices for Authors<\/em>, Scriptorium Publishing:\nhttps:\/\/www.amazon.com\/Dita-Style-Guide-Practices-Authors\/dp\/0982811810<\/a><\/span><\/p>\n\n\n\n
Microsoft Style Guide (en anglais), consult\u00e9 en ligne :\nhttps:\/\/docs.microsoft.com\/en-us\/style-guide\/welcome\/<\/a><\/span><\/p>\n\n\n\n
Nolwenn Kerzreho, Training technical communication students in structured content using DITA<\/em>, dans Current Practices and Trends in Technical and Professional Communication<\/em>, ISTC.\nhttps:\/\/www.amazon.com\/Current-Practices-Technical-Professional-Communication\/dp\/0950645990\/<\/a><\/span><\/p>\n\n\n\n
- Adoption de nouvelles pratiques <\/em>\u2013 de nouvelles pratiques li\u00e9es aux responsabilit\u00e9s \u00e9largies notamment gr\u00e2ce \u00e0 la r\u00e9daction structur\u00e9e et modulaire mais aussi \u00e0 la publication vers de nouveaux formats.<\/li>
![\"\"](\"https:\/\/www.ixiasoft.com\/wp-content\/uploads\/2021\/02\/Nolwenn.png\")
<\/figure>\n\n\n\n