Affichage des articles dont le libellé est documentation technique. Afficher tous les articles
Affichage des articles dont le libellé est documentation technique. Afficher tous les articles

12/03/2015

Le boss qui dit NON (formation continue)

Parfois les managers, chefs de projets, directeurs, "Head of..." manquent d'arguments pour refuser, aux membres de leur équipe,  une formation/une participation à un congrès professionnel, à un salon.

On peut les aider. Voici cinq arguments...

__________________________________ 1. Manque de temps 






"On n'a pas le temps, on doit livrer 2 manuels à la fin du mois"


_________________________________________
2. Manque de budget
"La situation économique est telle que nous avons d'autres priorités"
[par exemple, produire de la documentation que personne ne lit]


  •  Avez-vous seulement jeté un oeil sur le budget "formation" de votre entreprise ?
  •   Savez-vous que votre entreprise COTISE déjà auprès des organismes de collecte (OPCA) ?  Les fonds sont DEJA verses. Qui va maintenant les utiliser ?

 __________________________________

3. Manque de programme de formation
"On n'a pas de programme, donc on ne fait rien"



 

  • ... mais vous avez une obligation de formation vis-à-vis de vos salariés (loi de Mars 2014). Vous devez leur offrir une possibilité de formation tous les deux ans, sinon vous êtes passible d'une amende

___________________________________ 4. Manque d'agrément comptable
"Pour financer un déplacement du salarié à un congrès, je vais essuyer un refus de la compta. Pas question de m'engager sur ce terrain-là"



  • Savez-vous seulement qu'il existe, dans le plan comptable, un compte 625 - Déplacements, missions ? Il n'est pas nécessaire de réserver ce compte aux dépenses somptuaires des cadres supérieurs se rendant à leur congrès aux Maldives.
___________________________________
5. Le pouvoir de dire NON





C'est ce qui fait un vrai boss : utiliser son pouvoir de dire NON ! Ca le distingue de la valetaille (qui, elle, doit toujours acquiescer).

______________________________________
Calendrier
Les prochaines réunions, conférences, congrès professionnels sont d'excellentes occasions de maintenir à flot ses compétences en documentation technique  :



 ... Et si vous invitiez votre boss à vous accompagner à l'un de ces ateliers ?

25/02/2015

Minimalisme : A la recherche de l'info perdue...

Le 4e principe du minimalisme nous recommande  "Support reading to do, study and locate". On s'arrêtera sur la phase "localiser/trouver" (l'information pertinente).
 

Trouver rapidement l'info exacte 

Prenez Alcibiade, principal rédacteur chez SnowDamm, fabricant de canons à neige, qui a terminé "son" manuel opérateur. 350 pages, mise en page très carrée, formatage de première classe et délais maintenus à 100%.

Grande satisfaction... et, subitement, la Tuile !
 

Accident corporel autour d'un des canons à neige : l'opérateur a la main coupée. S'ensuit la réclamation du client : c'est de la faute du matériel (et du manuel).

Chez SnowDamm, c'est l'alerte au niveau du management : a-t-on bien mentionné, dans la documentation, comment graisser les disques XYZ-23 ?


Sueurs froides chez le rédacteur : "euhhh, oui,... Anastase, l'ingénieur, m'en avait parlé, donc je l'ai mis dans la doc !"

"Oh, Alcibiade ! apportez-moi la preuve. La documentation, sur mon bureau ! Tout de suite ! On court au procès ici ! Dépêchez-vous !" s'énerve le boss.

OUF ! Le rédacteur avait bien mentionné la manip' pour graisser correctement les disques. Alcibiade est un homme tranquille !

Après examen, manque de chance : la procédure n'en était pas une et, surtout, elle était difficilement décelable par l'opérateur.

En effet, bien cachée dans une note de bas de page, en fin de section "Catégorie d'huile de graissage pour le canon SnowDamm", on déniche l'information :


"NOTE : Une optimisation de la phase de graissage pour le disque XYZ-23 est obtenue en débranchant la machine après avoir enclenché le mode "REVERSE"

Rien sur "Assurer la maintenance des disques"  ou "Effectuer le graissage des disques".


Quels sont les risques à ce stade ?

Importants...! En effet, au moment du procès, l'entreprise devra répondre aux questions "qu'avez-vous fait pour éviter l'accident ?" ou "Donnez-nous la procédure précisant les conditions d'un graissage sécurisé ?"

Et là, la note mal torchée et bien cachée
ne suffit pas !

La juriste et la doc

En effet, Laura, jeune juriste très efficace, attire notre attention sur cet arrêt de la Cour d'Appel de Versailles, du 20 mai 2005, faisant intervenir l'UFC-Que Choisir et la Sté Totalgaz. La Cour a jugé abusive la clause par laquelle l'utilisateur reconnaissait avoir reçu communication des notices de sécurité, non seulement en raison de son impression en caractères peu lisibles, mais aussi de son emplacement, au milieu des conditions générales. 


Et là, la jurisprudence tranche : l'info est bien là, mais difficilement accessible, donc inefficace et inutile, c'est-à-dire inexistante.



Fictive cette histoire ? ... 

Que nenni ! Regardez  cet extrait du rapport de l'accident ferroviaire de Brétigny. Le Bureau Enquete Accidents, BEA, a demandé à la SNCF de clarifier -dans la documentation- les règles de maintenance des éléments boulonnés, parce que :
"Pour trouver la norme de serrage qu'applique la SNCF à un boulon, il nous a fallu éplucher des dizaines et des dizaines de pages" 
Ainsi donc, il y aurait un lien entre un accident grave et des difficultés à trouver l'information dans la documentation. Délicat, n'est-il pas ?



Recherche infructueuse, cible manquée

In fine, rappelons-nous les propos de notre éminent confrère Michael Priesley (un des grands noms dans l'implémentation DITA) : "On-site search engines fail 70% of the time".

De même, dans un article de la revue "Best Practices" de juin 2014, Dr. JoAnn Hackos

indique "43 percent... said that they have so many overlapping versions of their content that customers cannot find the information they are looking for"

Ce qui signifie que, dans 43 % des cas, les rédacteurs ont manqué leur cible. Pour les utilisateurs, l'information fournie n'existe pas ...

On essaie d'y remédier ?

28/01/2015

Comment (bien) démarrer un projet de documentation ?




Que vous optiez pour une documentation minimaliste ou plus simplement structurée, il vous faut DE-MA-RRER !

S'asseoir devant une page blanche ou copier/coller le vieux manuel de 2001, n'est PAS la bonne solution !





_________________________________________
De la méthode & de la norme (ISO 26 514)!
 
Pour envisager des processus plus efficaces et économiques, contactez-nous ! Nous pourrons organiser une présentation dans vos locaux ou dans un lieu à convenir ensemble.

 


On y parlera 


  • définition des besoins, 
  • utilisabilité, 
  • profil utilisateur, 
  • récapitulatif des tâches, 
  • modélisation de procédure, 
  • feuille de route du rédacteur, 
  • etc.

 




 ________________________________________
Bien démarrer en 2015 ?

Un Guide rédactionnel ne vous dit rien ? Une procédure orientée tâches ne vous intéresse pas ?... Une Short Description vous laisse indifférent ?

N'hésitez pas à nous en parler : un message électronique  suffit ;-)

 




Comment bien démarrer 2015 ? 
C'est démarrer avec les bonnes méthodes !

26/10/2014

Utiliser mon DIF pour un atelier "Documentation minimaliste" ?

 ... Non, mais et puis quoi encore ?

  _______________________________________

Quel contenu ?

  • Au cours de l'atelier, vous vous familiarisez avec les 4 principes du minimalisme, puis vous les mettez en application à partir de VOTRE documentation. Vous pouvez repartir avec vos propres documents retravaillés !
_______________________________________

 Quels destinataires ?

  • L'atelier est destiné à tout rédacteur/manager vraiment désireux de fournir (enfin !) l'information utile (... et peut-être cesser d'être la risée des utilisateurs qui n'aiment pas qu'on les prenne pour des handicapés du bulbe !)
_______________________________________

Quelle difficulté ?



Par exemple, que couvre le principe numéro 2 ("Anchor the tool in the task domain") ?

  • Le minimalisme a été développé par des professionnels de l'analyse du comportement des utilisateurs. En atelier, nous clarifions et mettons en application le résultat de cette analyse.
_______________________________________

 Quelle finalité ?

_______________________________________

 Que rejeter ?


Eliminer ? Ciel ! Est-ce vraiment nécessaire ?
  • L'utilisateur n'a pas besoin de trouver, dans un manuel, ce qu'il sait déjà : que sa tondeuse sert à couper le gazon et qu'une lame bien acérée peut couper un doigt de pied !


  • Un Ch'ti est-il vraiment capable de démontrer la pertinence du minimalisme ? 
_______________________________________

 Où s'informer ?

  • Si une information vous manque, n'hésitez pas à contacter [flacke [at] orange.fr]
_______________________________________

 Quels coûts ?

95 heures de travail perdues par employé et par an...
  _______________________________________

 Quels commentaires ?

  • Oui, mais, qu'en pensent les participants ?





03/05/2014

Grammaire, conjugaison, phraséologie... Quel ennui !

Dans un raccourci fulgurant, certains rédacteurs pensent qu'en implémentant les règles du minimalisme, ils peuvent passer rapidement sur ces scories que sont les règles de
grammaire, de conjugaison et autre horreurs comme l'orthographe.


Puisque le minimalisme cherche à éliminer le superflu, éliminons les rigidités grammaticales !


 La conjugaison ? quelle abomination !

Et pourtant, parmi les principes de base de la rédaction "minimaliste", on trouve :  "Rédiger au présent" (jamais au futur). 
En effet, l'utilisateur veut savoir ce qui va se passer s'il appuie sur ce bouton vert MAINTENANT, pas dans 30 minutes.
  • Appuyez sur CRTL+ALT+XXX                                                                      L'enregistrement démarre. 
        (et non pas "L'enregistrement va démarrer" ou "L'enregistrement démarrera")

Dans une présentation disponible en ligne, notre collègue Sharon B.  recommande, dans sa diapo n° 25, de rédiger à la voix active et au temps présent.

Dans sa colonne de droite, elle indique donc "Present tense" et donne des exemples dont :

 "Your email is automatically sent the next time a network is found"


... oui, un abysse s'ouvre devant nous  !

Si cette phrase est au présent (et accessoirement à la voix active), je veux bien être condamnée à nettoyer la place de la Concorde à la brosse à dents !

Dans les temps antédiluviens, on faisait la différence entre le présent et le passé composé : "Votre e-mail est envoyé automatiquement dès que le système trouve un réseau" (passé composé)
-et-
"Le logiciel envoie votre e-mail" c'est du présent (et de la voie active).

Pour les hésitations en conjugaison, voici de quoi vous rattraper aux branches...

Voix passive ...quelle dérive !

Tous nos grands maîtres en documentation technique s'accordent pour nous recommander : "N'écrivez jamais à la voix passive". Tout simplement parce qu'on ne sait jamais, dans ce cas, QUI fait l'action.


Comme par exemple :
"Le logiciel est démarré en appuyant sur le bouton"   -ou- "L'alarme est neutralisée après le déclenchement du levier vert".

D'accord, mais qui appuie sur le bouton ? le perroquet ? la musaraigne qui passait par là ? ou alors est-ce que le logiciel est programmé pour déclencher un appui sur le bouton ?

De mauvaises langues rapportent que, lorsque certains rédacteurs tournent leurs phrases au passif, c'est parce qu'ils n'ont pas compris le fonctionnement du système (et ne veulent pas trop se fatiguer à chercher)... des mauvaises langues, je vous le dis ! 
 

En minimalisme, une seule voix : la VOIX ACTIVE !

                  Dès que vous appuyez sur le bouton XXX, le logiciel démarre
Malheureusement, notre collègue californienne n'a pas été touchée par la grâce de la voix active (vu qu'elle ne fait pas la différence entre les deux voix...)







Allons, l'essentiel est que la collègue Sharon B. puisse continuer à organiser ses séminaires, ses brassages d'air et son "manque-pas-d'air" (voir ses commentaires, sous sa présentation Slideshare, lorsqu'on lui fait remarquer ses dérapages...)




Cours particulier pour la chère Sharon :

(a) les phrases au futur :
- The Widget will print the report
- The Widget will save the file
- The email will be sent if a network is found (futur composé)

 (b) les phrases au présent (et à la voix active) :
- These steps may prevent the brake pedal from functionning
- Your report prints
- During these steps, the brake pedal does not work
(c) Phrases au passé composé (et au passif)
- Your email is automatically sent the next time a network is found
- The file is saved
                                                                                                                      

Conclusion, le minimalisme ne consiste pas à minimaliser l'application des règles de
grammaire et de conjugaison, mais à bien veiller que tout ce qui est écrit est grammaticalement correct.


Il faut que l'utilisateur comprenne facilement ce qui est indiqué, mais aussi que le traducteur n'ait pas à DEVINER ce que l'on a voulu dire...

02/04/2014

Découvrir l'intérêt des tests utilisateurs...

... ou lorsque la poule découvre l'oeuf

Dans un article paru dans le N° 1 de la revue DOCUMENTALISTE - Sciences de l'information,
on trouve un article "Communication et rédaction technique : test et oralité."

Oralité et documentation technique
Comme l'oralité en documentation technique relève du mystère, on poursuit la lecture.
"Les cursus devraient ...proposer des enseignements sur la collecte d'informations auprès d'utilisateurs réels, la gestion des réunions de suivi, la gestion des conflits, l'organisation de tests, etc."
Si l'on entend "cursus" par "cursus universitaire", on ne peut que s'étonner d'une telle assertion. Nombreuses sont les universités françaises qui n'ont pas attendu 2014 -et le papier de l'auteur- pour enseigner l'art du "usability testing".

Assertion particulièrement odieuse lorsque l'on sait que la formation Master 2 Spécialisation Rédaction-Communication de l'Université de Haute-Bretagne organise, non seulement des tests utilisateurs pendant les cours, mais effectue, avec les étudiants, des tests de suivi oculaire.

Qualité des documents
"La qualité des documents que nous avons produits n'a, quant à elle, pas toujours évolué positivement,alors même ...que les formations confirment que c'est la bonne manière de procéder... mais sans toujours expliquer comment y parvenir concrètement."
indique l'auteur.



 Effectivement, lorsque l'on vit depuis 20 ans dans une grotte de l'Oural septentrional, on n'a pas accès aux publications sur le métier. 
Par exemple, l'article "Evaluer l'efficacité des documents techniques procéduraux : un panorama des méthodes" dans lequel on parle d' "évaluation centrée sur l'utilisateur...réalisée à partir d'un échantillon d'utilisateurs provenant du public-cible" . Cet article date de 2002 !

Les enseignants, les rédacteurs ne savent pas  "expliquer comment y parvenir concrètement." ?

Pourtant, le Prof. Franck Ganier -qui, lui, a de la méthode- précise :

"Les méthodes  basées sur l'implication d'utilisateurs dans l'évaluation sont destinées à vérifier si les caractéristiques du document sont suffisamment adaptées aux caractéristiques perceptives et cognitives des utilisateurs impliqués dans la recherche ou la compréhension des informations..."

De même, Franck Ganier indique, dans son article "De l'analyse des fonctionnements cognitifs à l'ergonomie des aides opératoires" (janvier 2002) :

"Sur le plan ergonomique, l’utilisation de ce modèle comme support à la conception de documents a permis de réaliser des documents procéduraux plus performants en termes d'aide opératoire, tant au niveau de la recherche d'informations qu'au niveau de leur lecture / utilisation."

Ainsi donc, les formateurs sont bien capables de fournir des méthodes, basées sur des tests utilisateurs, pour améliorer la qualité de la documentation produite... et ceci depuis des décennies !

Processus centré sur les tests
Dans certaines parties de France, le temps s'est arrêté. L'auteur pose -en 2014- ainsi la question :
"N'est-il pas temps que les désormais nommés "communicateurs techniques" s'attaquent à ce problème de communication pour le résoudre en mettant en place ce qui est nécessaire et indispensable : un processus centré sur le test ?"
Mais savez-vous, cher gloseur, que le manuel "A practical guide to usability testing" (Joseph S. Dumas et Janice C. Redish) a été publié en 1993 ?... il y a 20 ANS ! et que ce manuel est fortement recommandé dans les formations à la rédaction technique ???  
Des générations entières de rédacteurs techniques ont appris à faire des tests auprès de leurs utilisateurs AVANT votre publication de 2014 !

En disant
 "C'est pourquoi le test s'avère incontournable pour contrôler que (sic) le résultat théorique attendu est bien obtenu en réalité... mais ceci de manière systématique, en l'intégrant au processus"
 l'auteur enfonce des portes ouvertes. Tout ceci a été étudié et documenté bien plus sérieusement dans le recueil "Comprendre la documentation technique" (Ed. PUF, 2013)

Question oralité... on reste bouche bée
"Il me semble indispensable de mettre l'accent sur les compétences orales des futurs rédacteurs...  L'aisance à l'oral est malheureusement la grande oubliée"


Voilà encore une belle assertion ! 

Dans les bonnes formations à la rédaction technique, on travaille avec un manuel -qui a échappé à la sagacité de l'auteur de l'article- et qui date de 1998 : "User and Task Analysis for Interface Design" (JoAnn Hackos et Janice Redish). 
Dans son chapitre 6, on lit "Interviewing users and others".

De plus, pour les personnes qui ne sont pas en décalage horaire et temporel permanent : un manuel dédié à l'interview d'utilisateurs a été publié en 2013. "Interviewing Users - How to uncover compelling insights". Auteur Steve Portigal, éditeur : Rosenfeld.

Extraits :
 "User Insight in the Design Process",  "When to use interviewing", "The Impact of interviewing", "More than just asking questions", etc.

Pensez-vous qu'avec tout cela, on ne saurait pas vraiment interviewer un utilisateur ?

Alors, en matière de tests et d'utilisabilité, tout a été dit, analysé, discuté. Pourquoi tenter de  (mal) ré-inventer la roue ?

Quels tests ?

Ce qui est particulièrement décoiffant dans cet article, c'est l'imprécision : il est question de test, mais de quels tests ? Tests de résistance ? Tests d'orthographe ? Tests de lisibilité ?...
Les véritables professionnels appellent cela des _tests d'utilisabilité_ ("usability tests").

Les champions du domaine, outre les auteurs cités, sont Jakob Nielsen et, plus récemment, Gerry McGovern. Aucun d'entre eux n'est cité dans l'article... ce qui dénote un sérieux manque de professionnalisme.


Minimalisme et tests d'utilisabilité ?

Et bien oui, après un premier jet d'un guide utilisateur, on procède à des tests d'utilisabilité en sélectionnant des utilisateurs lambda à qui l'on confie une tâche précise. En suivant le manuel, ils doivent être en mesure d'obtenir le résultat escompté. Si l'utilisateur trébuche, le rédacteur a mal fait son travail... that's all!

Ceci est documenté dans l'article de Stephanie Rosenbaum "Follow-up on Training in Minimalism" (in Minimalism beyond the Nurnberg Funnel) où elle parle de "conducting usability testing prior to release", "talking to users before and after instituded minimalist documentation" ou "sending out 100 user surveys".


Norme ISO 26 514 et les "Usability tests"

Délibérément, l'auteur décide d'ignorer tous les travaux de recherche dans le domaine des tests et de l'art d'interviewer les utilisateurs. C'est son choix.

Mais pousser l'outrecuidance à ignorer la norme ISO 26 514 "Ingénierie du logiciel et des systèmes - Exigences pur les concepteurs et les développeurs de la documentation de l'utilisateur" qui, au point 8.3.2, sous "Usability tests" indique :

"User tests are the most acceptable method of checking that the information provided in the documentation is what users need..."

cela frôle l'incompétence ! Notons par ailleurs que cette norme date de 2008 et qu'elle constitue, dans plusieurs universités françaises (*), le "bréviaire" de la rédaction technique.

Alors, on sort de sa grotte, on délaisse le nombrilisme et l'on regarde hors de son périmètre ... en commençant par faire un tour dans une bonne bibliothèque ?


___________________
(*) Université de Bretagne Occidentale, Université de Haute-Bretagne, Université Catholique de l'Ouest, entre autres...



12/03/2014

Booster l'efficacité de votre documentation !

Vous souhaitez actualiser, autour d'un café-palmiers, votre savoir-faire pour optimiser votre documentation produits en passant au minimalisme !


 Faites-le savoir !

Topic : au centre des discussions, le volume de la documentation, son coût, son utilité et le feedback de vos utilisateurs.

Avant-goût : la documentation minimaliste et structurée ne s'applique pas à votre domaine ? ... Jetez un oeil sur ces exemples :

- Transformation d'une documentation-fleuve en une documentation structurée 
- Passage d'une documentation romancée à une documentation minimaliste (enfin  !)


____________________________________________

Pour en parler, faites-nous signe !
____________________________________________

Vous n'avez pas besoin de passer votre documentation à la grille du minimalisme ? C'est ce que pensaient les rédacteurs du site nucléaire Three-Mile-Island.

Selon l'émission Planète Terre, dans la salle de contrôle du site nucléaire, au moment de la catastrophe et alors que tous les voyants étaient au rouge, les ingénieurs devaient lire un manuel de 150 pages ! ... malaise, vous avez dit malaise ?
________________________________________________

Le prochain atelier "Minimalisme : créer l'information dont on a vraiment besoin" aura lieu les 15-16 décembre 2014 à Vélizy (Paris) et se tiendra en français. Les inscriptions sont ouvertes !

07/03/2014

Minimalisme, qualité et lisibilité (...foutaises ?)

En parlant minimalisme, on entend souvent : c'est réduire la longueur des mots !


Et bien non, ce n'est absolument pas cela. Tous les mots, à partir du moment où ils sont compris et utilisés par l'utilisateur final sont utilisables dans une documentation technique.

En matière de longueur des mots, quelques esprits qui s'autorisent à penser pour les autres, nous recommandent l'emploi de tests de lisibilité pour mesurer la qualité de la documentation technique. Vous savez, les tests de Flesch-Kincaid, Fog, etc.

On dispose même d'outils disponibles en ligne qui "calculent" le taux de lisibilité d'un document. Amusant, non ? Pour la langue française, choisissez (sous "Method") l'option  Kandel & Moles.

______________________________________________________________________________

Malheureusement, ces petits joujoux ne résistent pas à un examen un peu approfondi

  En effet, les tests sont basés sur 2 critères : 
  • la longueur des phrases 
  • la longueur des mots. 

Plus le mot est long, plus il est considéré comme "difficile" à comprendre. Comme l'indique
le Prof. Franck Ganier :
"... plus les phrases sont longues et le vocabulaire complexe, moins le texte est "lisible"  .

Soit, mais en y regardant de plus près, selon  F. Ganier (*) :
"si l'on considère que ces formules ont été créées à l'origine pour déterminer le niveau de lecture correspondant  à des textes écrits pour des manuels scolaires, on peut s'interroger sur la pertinence et la validité de leur usage pour l'évaluation de documents techniques". 

Erreur d'aiguillage, donc. C'est applicable aux manuels scolaires et pas transposable en rédaction technique.


De plus, ces tests n'ont été conçus que pour la langue anglaise, qui a une bien autre structure que le français ! Le test de Kandel et Moles n'est qu'une (piètre) adaptation.

Par ailleurs, Ginny Redish, dans un article datant des années '80 (**)   descend en flammes la pertinence de ces tests :

"A formula that counts only sentence length and word length or familiarity of the words is not sensitive to the order of the words or the complexity of the grammar. Sentences with misplaced clauses, dangling participles, or misused words will score as well on a readability formula as sentences of equal length that have none of these problems".
_____________________________________________________________________________

Gadgets ?

Nous voilà en présence de gadgets puisque ces "tests" ne tiennent compte que de la longueur des mots, mais pas de leur position dans la phrase...

In fine, prenons un exemple : le terme "excipients" doit être considéré comme simple à comprendre puisqu'il ne dépasse pas les 3 syllabes en français.  Par contre, le terme

"électrocardiogramme", qui en compte 6, sera estampillé _difficile_. Or, dans la réalité, demandez à un quidam ce qu'il entend par "excipients" et par "électrocardiogramme"...Ce n'est certainement pas le plus long qui pose problème !

Alors, en conclusion, on ne va pas inclure, dans notre projet d'évaluation de la qualité de la documentation minimaliste, de tests de lisibilité... sauf pour s'amuser.

Et l'on ne va pas passer notre temps à raccourcir les mots pour faire plaisir  à Messieurs Flesch et Kincaid !



 ____________________________________________________________________________
(*) "Evaluer l'efficacité des documents techniques procéduraux: un panorama des méthodes", PUF, Le Travail humain, 2002/1, Vol.65
(**) "Understanding the limitations of readability formulas", in IEEE Transactions on professional communication, 1981,vol. 2

Voir aussi: "Comprendre la documentation technique", Franck Ganier, Editions PUF

26/12/2013

Ma documentation est de qualité !


Nul doute, puisque vous y avez apporté toute l'attention et les compétences nécessaires.

Par exemple, le formatage, la mise en page, le choix des caractères, l'outil d'aide à la rédaction, le correcteur orthographique (non, vous êtes au point et n'en avez pas besoin...), les notes des développeurs, le logiciel de capture d'écrans, l'outil de création graphique, etc.

Vous avez constitué votre équipe de rédaction et lui avez fourni un planning ? Bravo !


Votre Dream Team a travaillé d'arrache-pied en se délectant des nouvelles fonctionnalités du logiciel de mise en page.

Last but not least: vous avez faire relire l'ensemble du manuel par un "éditeur".

Tout est prêt pour la publication ? Champagne !...


Comment mesurer la qualité

En réalité, la qualité ne se  mesure pas exclusivement à la mise en page, évaluée par un membre de l'équipe de rédaction, mais sur des critères d'utilisabilité... effectués par l'utilisateur final !


Patatras ! L'utilisateur n'aime pas votre manuel... il ne peut pas s'en servir ; il ne lui sert à rien.
Vous avez investi 2 mois de travail pour 3 personnes et une semaine de révision qui se terminent par un rejet manifeste de la part du destinataire du manuel. Pas très brillant, n'est-ce pas ? Peut-on encore parler de qualité ?



Que vient faire le minimaliste dans ce scénario ?

Le minimalisme consiste à ne donner à l'utilisateur que l'information dont il a besoin pour accomplir une tâche. C'est à dire par exemple lui faciliter l'accès à l'information (principe n° 4).

Comment trouver rapidement l'information dont on a besoin ? 

A ce stade, le point crucial est la "Navigation" :


"This category highlights those aspects of a document that facilitate a reader’s ability to find relevant information. Is a logically grouped, easy-to-navigate table of contents provided, for accessing particular information?"
C'est pour cela que l'on fournira une table des matières, un index, mais aussi une rédaction
par rubriques (les fameux "Topics" sous DITA). Il n'est plus question de rédaction "waterfall" ou au fil de l'eau (Proust, James Joyce, Zola ne sont pas rédacteurs techniques...), mais de courtes procédures, très bien libellées et indépendantes.

Très bien libellées, cela signifie que le titre de votre rubrique doit être précis, "parlant" et correspondre à la terminologie de l'utilisateur.

Savoir naviguer et savoir éliminer !

Pour pouvoir naviguer, il faut permettre la circulation et donc éliminer les "bois flottés" qui entravent la recherche rapide.

Dans cet article  "Tips and Tricks: 10 Heuristics for Evaluating Documentation Usability"
on nous rappelle l'essentiel, c'est-à-dire élaguer et ôter ce qui n'est pas pertinent :
 "8. Minimalist writing
Topics should avoid information that is irrelevant. Every extra unit of information in a topic competes with the relevant information, which diminishes the findability of relevant information."

Effectivement, non seulement il est essentiel de travailler en (petites) rubriques , mais il est capital de ne pas NOYER l'information pertinente dans un marigot de bla-bla superflu.

C'est ce que nous démontre, très à propos, Gerry McGovern dans son article  "From managing inputs to managing outcomes" :

Customers want to know more in order to make better decisions. But the information must be easy to find and easy to understand."

Pour être de qualité, l'information doit être facilement accessible  et compréhensible... pas uniquement bien emballée !

Utile, efficace et sans paroles ?

Last but not least, voici un exemple patent d'une information utile, efficace et d'accès aisé. Il s'agit d'une video expliquant le montage d'un lit d'enfant. Aucun avertissement ("attention, l'utilisation d'un tournevis peut être dangeureuse !"), aucune note ("Le montage du lit doit être effectué par un professionnel dûment formé"), aucune "consigne de sécurité à lire absolument"... les instructions sont là, disponibles après 1 ou 2 clics et sans paroles !

Pour l'équipe de rédaction, il n'est plus question de taille de caractères, d'avant-propos, ni de traduction... puisque la video est sans paroles. Et pourtant, l'utilisateur trouve facilement l'information dont il a besoin pour monter le lit.