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.

Documentation médicale:l'infobesity,ça se soigne, Docteur ?

Dans le secteur de la santé, on connaît l'importance de la documentation. C'est pour cela qu'on fournit des manuels de 500 pages destinés au personnel médical !

Les équipes de soins ont -surtout dans les hôpitaux français- le temps de s'arrêter, une

tasse de café à la main, pour lire 3 chapitres du guide utilisateur...

Et si, au lieu de leur fournir une documentation inexploitable, on cessait de dégurgiter du texte pour le plaisir (le nôtre, pas le leur...) ?

Evitons l'infobesity !

Selon Dr. JoAnn Hackos : 
 "In fact, the shorter and more lean the text, the more likely it will be read"

En clair, en documentation : ce n'est pas parce que c'est long que c'est bon !

Eliminer, dégraisser... c'est possible !

Eliminer ce qui ne sert qu'à agacer l'équipe médicale (elle a un patient à traiter et ne cherche pas, dans le manuel, ce qu'elle sait déjà), comme par exemple :

Mais bien sûr, le manipulateur radio a vécu ces 40 dernières années dans une grotte de Mongolie inférieure et ne sait pas qu'un voyant vert indique que l'appareil marche !

De  même, il n'est pas nécessaire d'expliquer, plusieurs fois, que pour sortir d'une application, il faut appuyer sur EXIT.

Tout est bon à mettre dans la documentation !

A trop vouloir tout dire, l'utile et le futile, certains rédacteurs se prennent les pieds dans le tapis.

 Ainsi, le mode d'emploi d'un défibrillateur précise, dès la page 5, qu'il faut aller vite : 
 "... les taux de survie liés aux arrêts cardiaques...sont directement liés à la rapidité d'intervention... Chaque minute de délai entraîne une diminution des chances de survie d'environ 10 %"

Bien vu, mais alors pourquoi fournir à l'utilisateur un manuel de 108 pages si l'on n'a que quelques minutes pour sauver une vie ?

Sur-irradié à cause du manuel... en anglais !

Au lieu de se concentrer sur le superflu et l'inutile, il est préférable -en matière de matériel médical- de s'impliquer dans la traduction des documentations dans la langue de l'utilisateur. Cela évitera de graves accidents.
 

Il a donc fallu plusieurs décès et des centaines de personnes mutilées pour que les autorités sanitaires rappellent aux fabricants leur obligations. 

Dans sa note d'août 2007, l'AFSSAPS  rappelle  dans son "AVIS AUX FABRICANTS DE DISPOSITIFS MEDICAUX DE RADIOTHERAPIE" , l'article R. 5211-20 du Code de la Santé Publique qui stipule que la notice qui accompagne le dispositif médical  et toute information relative à son fonctionnement doit comporter une version rédigée en français.

Il était temps... puisqu'un autre problème de sur-irradiation faisait ressortir que
  " Les appareils avaient été là aussi mal réglés car le manuel d'utilisation était en anglais. "

La norme et ses contraintes 
Trop souvent, le rédacteur oublie de penser d'abord à son utilisateur. Il préfère suivre aveuglément la norme.

Ainsi, la norme IEC 62 083 indique, dans son annexe A : "Les INSTRUCTIONS D'UTILISATION et la description technique doivent contenir toutes les informations nécessaires pour effectuer sans risque: les opérations ... d'installation, d'utilisation et de maintenance du  matériel..."

Le rédacteur distrait composera donc un beau, gros manuel -499 pages seulement- incluant une Introduction, un A propos de... (ou Aperçu), une section Généralités (dans laquelle il noiera une information capitale) puis une section Installation (surtout si le matériel est volumineux et très compliqué), suivie d'une section "Consignes de sécurité" (24 pages d'avertissements). Il abordera alors la partie "Utilisation". On sera alors à la page 189.

A ce stade, il s'apercevra qu'il manque une section "A propos de ce manuel" dans laquelle il décrira les conventions typographiques, les icônes et autres futilités.

Lorsque le manuel aura atteint la page 250, le rédacteur formé au minimalisme lui expliquera que tout cela est INUTILE et que l'utilisateur a besoin de trouver, dans la minute qui suit, une  information précise sur la mise à zéro des données du patient avant traitement... C'EST TOUT !

Et la norme ?

C'est exactement ce que dit la norme : fournir les "informations nécessaires pour effectuer sans risque les opérations d'utilisation du matériel".

La documentation ne doit contenir que ce dont l'utilisateur a besoin ; un médecin n'a pas besoin des guides d'installation (parce que c'est le fabricant qui procède à l'installation) ni du guide de maintenance (le fabricant doit s'en charger). Ou alors voulez-vous vraiment que le médecin  revienne le dimanche s'occuper de la maintenance de son scanner ?

C'est pourquoi le rédacteur qui met en avant les besoins de son utilisateur créera SEPAREMENT :

• un manuel d'installation (destiné au représentant du fabricant chargé de l'installation) 
• un manuel de maintenance pour le technicien qui vient régulièrement vérifier les paramétrages et l'usure du matériel.

La bonne blague espagnole 

Ne manquons pas cette petite histoire de documentation pharmaceutique inadaptée... celle des notices diffusées en espagnol pour le personnel médical anglophone (et en

Grande-Bretagne).

Comme le fabricant n'avait plus de notices en anglais, il a envoyé les notices en espagnol ! 

Il faut juste espérer que les hôpitaux britanniques avaient assez d'infirmières espagnoles à disposition !

C'est certainement une nouvelle version de ce que l'on appelle "parler anglais comme une vache espagnole "

Minimalisme appliqué à la documentation médicale

Pour un exemple de mise en place des principes du minimalisme pour la documentation médicale, vous pouvez suivre cette présentation faite à la Scientific Conference on Strategic Development and Performance in Healthcare Institutions en janvier 2013.

Aéronautique & documentation minimaliste : go or no go ?

Dans le nucléaire, on peut appliquer sans hésitation les règles de la documentation minimaliste.

Soit, mais pas dans l'aéronautique, sacrebleu !

Pas besoin de minimalisme ? C'est à voir...

Ainsi, en 2005, AIR FRANCE, dans sa démarche pour "simplifier les procédures des équipages" a fait une refonte du "manuel d'exploitation" ... qui a été "complété, 3 semaines plus tard par deux cent cinquante-cinq (255) pages de mise à jour et de corrections"... 

Mais ce n'était pas du goût du porte-parole du Syndicat national des pilotes de ligne : 

"Quand vous avez une documentation pléthorique, des dizaines de pages superflues, les pilotes ne peuvent pas se reconnaître dans ce qui doit être le socle d'une culture commune"(*)

C'est là le coeur de la démarche minimaliste : ne donnez à l'utilisateur que l'information dont il a besoin. Pourquoi lui fournir une documentation volumineuse si elle n'est pas exploitable ? 
  

Du volume, sinon rien !

Ce même phénomène est relevé dans le rapport d'accident du vol TAM à l'atterrissage sur l'aéroport de Sao Paolo : 

"The A-320 manuals have lots of pages and are hard to consult,mainly during the flight"

Effectivement, ce n'est pas le volume de la documentation qui la rend utile, mais son accessibilité. Est-il facile d'obtenir l'information sur les "reversers" lorsqu'ils ne fonctionnent plus ? Combien de pages et de chapitres
feuilleter avant d'avoir exactement la procédure de secours ?

 
Très, très significatif également, le rapport d'accident du vol 1549 qui, après

décollage de La Guardia, a dû amerrir dans la baie de l'Hudson.   

L'excellent capitaine Sullenberger a suivi les procédures et, en duo avec le co-pilote, a pointé la "check-list".

Toutefois, heureusement qu'il ne soit pas allé jusqu'au bout des listes de pointage, parce qu'il aurait terminé sa course au fond de l'Hudson :

"However, according to post-accident interviews and CVR data, the flight crew did not complete this Checklist, which had 3 parts and was 3 pages long; although they were able to complete most of part 1, lack of time precluded starting Parts 2 and 3."

C'est là un des points-clés d'une formation au minimalisme : est-ce que la documentation est utile à l'utilisateur dans son environnement de travail   ?

C'est ce que Dr. Hans van der Meij appelle "Anchor the tool in the task domain". 

Terminologie ? un gadget négligeable !

 La terminologie... quantité négligeable aux yeux de certains.

En s'arrêtant sur la liste des rapports d'accidents et incidents publiée sur le

site de SkyBrary (initiative EUROCONTROL), on découvre, dans le rapport d'accident sur l'aéroport de Hambourg, un sérieux manquement en terminologie :

 "The terminology maximum crosswind demonstrated for landing was not defined in the Operating Manual and in the Flight Crew Operating Manual, and the description given was misleading“

Il semblerait que l'équipe de documentation ait oublié, ici, que la terminologie doit être CONSTANTE et COHERENTE !

Procédures ?... vous avez dit procédures ?

Non seulement les pilotes, mais les ATC (contrôleurs aériens) sont confrontés à une documentation défaillante. 

Ainsi, suite à un incident grave sur l'aéroport de Zurich-Kloten, les enquêteurs découvrent avec horreur que :

"the Zurich procedures contained no detailed description of how to manage simultaneous use of runways 16 and 28 for departures."

Le Bureau Fédéral de l'Aviation Civile Helvétique recommande donc que :

"the operator and users of Zurich airport should carry out a comprehensive analysis of the operating procedures and take all appropriate measures to reduce complexity and the systemic risks."

 Analyser les procédures pour suivre les actions à accomplir, analyser les

tâches de l'utilisateur et surtout mettre tout en oeuvre pour rendre le document clair et immédiatement utilisable, voilà les véritables mots d'ordre du rédacteur "minimaliste".


Produire de la documentation au kilomètre n'est PAS du digne d'un bon rédacteur technique ; mettre  toute son énergie pour fournir une documentation exploitable, immédiatement utilisable et sans ambiguité  est la caractéristique du rédacteur formé au minimalisme, celui qui ne donne que l'information dont on a besoin !
_____________________________
(*)  Extrait de "La face cachée d'Air France", 
p. 96--97, auteur : Fabrice Amedeo

Documentation minimaliste ?... pas dans le nucléaire !

Sûreté de fonctionnement : gros pavé ?

Pour garantir la sûreté d'utilisation et de fonctionnement dans le domaine du nucléaire, il

faut une documentation volumineuse, coûteuse et  conçue par des ingénieurs  dans un format établi et immuable.

C'est à ce prix que l'on contribue à la qualité d'utilisation des outils, machines et mécaniques... non ?

La vanne qui ne fait pas rire... 

C'est le titre de l'article publié le 4 septembre 2013 par le Canard Enchaîné qui relate les (graves) problèmes de montage d'une  

"vanne destinée à injecter des additifs chimiques dans un circuit de sécurité" Elle a été montée à l'envers !
"Ce défaut de montage a été tardivement repéré, car, parmi les "facteurs aggravants", les inspecteurs disposaient d'une "documentation de référence peu lisible".

AREVA et le mode d'emploi

Et, plus grave, dans la documentation :

  "la position du moteur était erronée" ! Le mode d'emploi était écrit en chinois ?"

(Le Canard Enchaîné du 4.09.2013)

Minimalisme et nucléaire

Gageons que cette documentation n'appliquait pas les principes du _minimalisme_
Pourquoi ? 

Si la documentation de montage induisait l'utilisateur en erreur, c'est que le rédacteur n'avait pas suivi le 2e principe du minimalisme :

"Se focaliser sur les véritables tâches de l'utilisateur",

 c'est-à-dire :

• appréhender ces tâches dans l'environnement de l'utilisateur (sur son lieu de travail)
• faire une véritable analyse des tâches et des utilisateurs.

(Voir l'article du Dr. Hans van der Meij : Anchor the tool in the task domain .

 Analyse des tâches de l'utilisateur

Dans le cas présent, il fallait demander à l'ingénieur/technicien spécialiste des vannes de simuler, dans l'environnement de travail, une installation.

L'idéal est de filmer les manipulations et d'enregistrer les explications de l'expert-métier. Bien entendu, le rédacteur, pendant l'interview, ne se contente pas de commenter "ah oui, ah bon, ah c'est d'accord..."
 
Mais il lui faut poser les questions les plus saugrenues possibles :

"Pourquoi prenez-vous la vanne par ce côté ? Combien de personnes pour installer la vanne ? Pourquoi vous avez ôté cette vis ? Comment avez-vous pu identifier la bonne vanne ? Où sont les références ? Pouvez-vous me montrer l'alimentation ? Comment vérifier que le montage est correct ? etc."

 Illisible ou inintelligible, la documentation ?

Quant à la documentation de référence "peu lisible", on hésite : était-elle peu lisible parce

que rédigée en MAJUSCULES sur FOND NOIR  ou GRIS ? ou alors faut-il comprendre "peu intelligible", c'est-à-dire difficile à comprendre ?

Elle pêchait peut-être par omission (des esprits chagrins diraient que le rédacteur n'était pas très au fait de l'installation de vannes, alors il s'est contenté de documenter un minimum pour ne pas se tromper -ou se fatiguer à faire des recherches- MAIS ce sont là des propos de MAUVAIS ESPRITS...).

 

Supputations : comment en est-on arrivé à cette grave erreur ?

On peut fort bien s'imaginer que le rédacteur n'a pas vu ni manipulé la vanne et qu'il se soit contenté d'une illustration (fiche produit). A partir de là, il a probablement _imaginé_ comment l'installer sur les circuits existants. Ce qui expliquerait une autre grosse bévue relevée dans le rapport d'inspection :

"Pas de connaissance de l'existence de différences de diamètre entre les orifices"...

 

Conclusion : le minimalisme dans la réalité

 La documentation basée sur les principes du minimalisme, ce n'est pas le rédacteur qui s'investit de façon _minimaliste_ dans son job, mais au contraire, celui qui fait des recherches approfondies et précises sur l'environnement de travail de l'utilisateur pour lui fournir une documentation correspondant à ses besoins !

___________________________________________
N.B Évalué à son lancement en 2005, à 3,3 milliards d'euros, l'EPR devrait finalement revenir à 8,5 milliards d'euros. Des malfaçons ont émaillé sa construction. Un exemple : les consoles du bâtiment réacteur - 45 appendices destinés à soutenir un pont roulant - présentaient des défauts de soudure (quotidien Ouest-France du 6 septembre 2013)