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.

11/10/2013

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.

02/10/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

08/09/2013

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)

24/07/2013

A quoi sert le manuel ?... à écraser les moustiques !


Dans un twitt récent, un utilisateur anglophone ouvre de nouvelles perspectives quant à
l'utilité de manuels utilisateurs  ...

Il a donc utilisé un gros manuel pour écraser le moustique qui l'agaçait.


Il s'agit d'un lourd manuel accompagnant une montre... L'auteur avait pourtant d'autres
méthodes pour se débarrasser de l'intrus !


Mais au fait, a-t-il vraiment eu besoin du manuel pour utiliser sa montre ? ... Le mystère reste entier.

 

Scandaleux ?

Pas vraiment. Dans les couloirs de grandes entreprises, on entend souvent d'autres options pour l'utilisation de manuels  :

(1) ça sert très bien à caler une table un peu bancale (version allégée d'un manuel)


(2) ça agrémente une bibliothèque (on a entendu parler de mur de manuels administrateurs destinés à masquer la présence de breuvages plutôt prohibés sur le lieu de travail...)

 Combien de temps ?

Oui, combien de temps est-ce que cette situation va perdurer ?

C'est simple : jusqu'à ce que les responsables du budget s'arrêtent sur le coût de leur documentation. En effet, le moment est venu de se demander : pourquoi produire des manuels volumineux et inutilisables (sauf pour trucider les moustiques) ?

Les rédacteurs techniques -en première ligne- doivent analyser leur production et  s'interroger.

 Comment rédiger autrement ?

Oui, et d'abord, pourquoi changer ?... on a toujours fait comme cela et, de toute façon, nos concurrents font la même chose.

En êtes-vous certain ? Est-ce que vos concurrents ne seraient pas en train, par exemple,

d'analyser leur documentation et de procéder à une "curation" (élagage des branches inutiles) de leur documentation avant de passer à DITA  et, par là même, réduire les coûts de leur documentation ?

Avez-vous remarqué : le développement de logiciels est dorénavant effectué en mode "agile", mais la documentation est rédigée comme au siècle dernier.

"Autrement" cela signifie rédiger pour être utile à l'utilisateur final et ne lui donner que ce dont il a besoin. Par exemple, éliminer toutes les introductions, généralités, à propos de... etc



Minimalisme : quel investissement ?

La méthode de rédaction "minimaliste" n'implique l'achat d'aucune formule miracle, aucune méthode en 20 volumes, aucun logiciel coûteux.


Le minimalisme s'apprend en deux jours de formation sur site et sous forme d'atelier en petits groupes et en français. 

That's all !
C'est fou, non ?

Vous hésitez ? Jetez un oeil sur l'article de Howard Schwartz, de SDL, publié dans le numéro de novembre 2011 des "Best Practices" de CIDM : "The Death of technical publications as we know it" .



Où trouver un atelier "minimalisme et documentation" en France ?

N'hésitez pas à prendre contact pour toute question sur le minimalisme et sur les ateliers.

15/07/2013

L' atelier "minimalisme et document procédural" en France : la FAQ


Pour 2015, si vous souhaitez co-organiser un atelier "Documentation minimaliste" en vos locaux, contactez les organisateurs. 

La FAQ du minimalisme


1. Le minimalisme, ça sert à quoi ?
Certainement pas à réduire la taille des mots ni à tronquer les phrases.
L'objectif est de donner à l'utilisateur (du produit et donc de la documentation) uniquement l'information dont il a besoin.  C'est le bla-bla, les considérations inutiles que l'on élimine, pas l'information utile.

Le minimalisme sert aussi à réduire le coût de l'infobésité



2. Le minimalisme ? Pas besoin de ça chez nous !

Une documentation "minimaliste" est utile et efficace, parce que _lue par les utilisateurs_.

...alors que la mauvaise documentation peut coûter 13,8 milliards de dollars par an !

Si vos clients vous retournent les produits, les utilisent très peu et très mal, ils ne vont pas, lors d'un autre achat, revenir vers votre catalogue !



Vos clients ont une bonne opinion de vos produits et de votre documentation. Ils n'en parlent pas comme ça, n'est-ce pas ? 






3. Rédiger pour le client du 21e siècle
Est-ce vraiment nécessaire, en entreprise, de rédiger la documentation  comme à l'époque de la machine à écrire mécanique ?

A votre avis, n'a-t-on pas progressé depuis les années 60 ? 


Avez-vous interrogé vos clients sur l'utilité des manuels et guides que vous fournissez ? 

Avez-vous une idée du temps passé par l'équipe du SAV à répondre aux appels des clients :

("Patron ?!! La hot-line est surchargée !!! C'est toujours les mêmes questions qui reviennent !...")
    Voici ce qu'en pense l'initiateur du site I Fix It :
"Guides and manuals have to be designed to be effective in the world we live today - not the world that we lived in 40 years ago.

It's the only way that documentation will ever get the respect and the attention it deserves".

4. Que produisent vos rédacteurs et à quel prix ?

Votre équipe de rédaction est en place depuis plusieurs années. Les rédacteurs connaissent bien vos produits.


Avez-vous pris le temps de vérifier l'utilisabilité de la documentation produite ?

Par exemple, le manuel utilisateur ne décrit pas en 10 lignes comment imprimer une page A4... 

Quelque chose comme :

IMPRIMER AVEC L'IMPRIMANTE ABC
L'imprimante ABC vous permet d'imprimer des feuilles au format A4.
Le format A4 est le format de lettre commerciale.


Pour imprimer avec l'imprimante ABC
- mettez l'imprimante sous tension
- sélectionnez la fonction "Imprimer" qui se trouve sur le menu
- tapez le nombre de feuilles à imprimer
- appuyez sur OK

Si l'imprimante ne fonctionne pas, éteignez et rallumez.
Sinon, appelez la hotline


...et ensuite vous faites traduire ce chef d'oeuvre de lapalissades en 28 langues ;-(((



5. Le minimalisme ne m'intéresse pas ; moi, je fais du DITA
Le minimalisme est indispensable à la rédaction sous DITA ("DITA authoring")
C'est exactement ce que pense Adobe.



6. Le minimalisme, c'est tout nouveau !
Jetez un oeil sur ce récapitulatif : Le minimalisme ça vient d'où


Ce n'est pas vraiment récent, puisque le premier ouvrage "The Nurnberg Funnel" date de 1990 ! Depuis, les principes n'ont fait que se préciser et s'améliorer.

7. Une formation éligible au DIF ? Y ai-je droit ? Comment faire ?
Le Droit Individuel à la Formation, c'est pour vous. La preuve...  


Ce DIF en 10 points va également compléter votre information.


8. Un atelier ?... ça fonctionne comment ?

Pas question de cours magistral, pas d'apprentissage par coeur, pas d'entonnoir de Nurnberg...mais de l'action, voire de l'interaction


Pendant deux jours, le travail s'organise en petits groupes. A partir d'exemples concrets apportés par les participants, on met en application les principes du minimalisme. Résultat : chacun repart avec SA PROPRE DOCUMENTATION "minimalisée"!


9. Le minimalisme, c'est avec quel logiciel ?  Combien coûte-t-il ?

Le minimalisme n'est lié à aucun logiciel ; c'est le contenu et non pas l'outil documentaire qui importe. Quel que soit votre outil usuel (y compris la plume d'oie...) vous pouvez adopter et pratiquer la rédaction minimaliste. 

Lors de l'atelier, votre seul outil, ce sont vos cellules grises !



10. Le minimalisme est réservé à la documentation logicielle
 Idée tristement fausse. 

Dans son webinaire du 12 juin 2013, Dr. JoAnn Hackos a confirmé appliquer les règles du minimalisme à la documentation de matériel médical. 

Les ateliers précédents ont accueilli des participants du secteur forage et exploration pétrolière, gestion d'immeubles, tracteurs et machines agricoles, téléphonie, gestion de réseau internet, matériel médical, etc.

L'atelier se tient exclusivement en français, par un formateur francophone.



11. Faut-il faire l'acquisition de manuels d'apprentissage ?
 Ce n'est pas indispensable. Une bibliographie mise à jour vous sera remise lors de l'atelier.
 

Toutefois, vous repartirez avec votre support de cours -en français- et un recueil d'exercices et exemples en français.


12. Le minimalisme a vraiment été mis en place dites-vous ? Chez qui ?


Tous les grands noms s'y sont mis, sans hésitation !



 Avec la documentation minimaliste, les coûts de conception ne portent que sur le contenu UTILE et EFFICACE pour une utilisation satisfaisante du produit.
 L'utilisateur n'ouvre jamais le manuel... sauf quand il a besoin d'une information précise. La trouve-t-il vraiment et rapidement dans votre documentation ?

 Savez-vous qu'un rédacteur non formé est plus coûteux qu'un véritable rédacteur professionnel ? 

L'amateur rédige pour le plaisir de rédiger (façon romancier) et produit des romans-fleuves inexploitables. Le professionnel rédige pour satisfaire aux attentes de l'utilisateur : il pense ergonomie, économie et utilisabilité !

En formant vos collaborateurs au minimalisme, non seulement vous les fidélisez, mais vous les préparez à la documentation sous DITA et à la rédaction en mode 'agile'
 A quoi peut servir un budget formation, sinon à former les collaborateurs pour les rendre plus compétitifs, à l'image de votre entreprise ?

 Se former en petits groupes, à partir d'exemples concrets, est-ce que ce n'est pas 
la solution optimale ?


Un manuel rédigé selon les règles du minimalisme a 90 % plus de chances d'être lu et utilisé qu'un manuel ("pavé") à l'ancienne !
 A votre avis, est-ce que vos concurrents ou vos sous-traitants ne sont pas en train de se former, eux, au minimalisme ?
 

Utilisateurs stupides et rédacteurs idiots ?



Les utilisateurs sont stupides

Dans son article, Stephen Turbek pense surtout qu'il sont

 "Stressed, Tired, Untrained, Passive, Independent, Distracted".

Oui, mais comment concevoir une documentation pour ce genre d'utilisateurs ?________________________
La documentation du 21e siècle ?

Dans son article "The power of free manuals", Kyle Wiens conclut en recommandant : 
"Rethinking documentation - ...Manual and guides can accomplish amazing things... But our experience has taught us that in order to be really effective, documentation has to be drastically rethought.

Guides and manuals have to be designed to be effective in the world we live today - not the world that we lived in 40 years ago. 
It's the only way that documentation will ever get the respect and the attention it deserves".
Non, mais je vous le demande, de quoi se mêle-t-il, ce Californien ?

La documentation produite en ce 21e siècle est excellente, faite par des professionnels, qu'on se le dise !

____________________________________
Les rédacteurs d'instructions sont des IDIOTS !

C'est ce qu'indique un twitt récent... 






Alors qu'un autre utilisateur se permet de twitter que "Google analytics help is so impossible to understand!"




 

 Ce n'est pas vrai !

La preuve : un rédacteur technique est capable d'expliquer à un conducteur de chariot-élévateur comment freiner :


Parce qu'il est évident qu'un cariste ne sait pas comment freiner... il ne l'a jamais appris.

 


 

____________________________________

La mauvaise documentation peut coûter 13,8 milliards de dollars par an ! 


Des esprits chagrins -en l'espèce, les consultants de chez Accenture- prétendent que la documentation de mauvaise qualité a coûté, aux USA et en 2007, 13,8 milliards de USD aux fabricants de matériel électronique :
" American consumers returned $13.8 billion in electronics in 2007.
Between 60 percent and 85 percent of this equipment was perfectly functional, but the purchasers returned it because of confusing interfaces,  features that were difficult to access, a lack of customer education and weak documentation.

These were all factors that excellent written communication could have solved—yet in its absence, many electronics companies found that they were frustrating customers to the point of initiating a product return, and their credibility was taking a hit."

Mais ça, je vous dis, c'est parce que toute l'électronique, maintenant, est faite dans des pays exotiques, là où l'on n'a jamais entendu parler de véritable documentation technique...


_____________________________________

Le "P" de point mort et la ceinture de sécurité unipersonnelle

  Et pourtant une équipe canadienne vient de mettre en ligne un recueil de perles issues de la documentation pour automobiles. Exemple :
"2013 Chevrolet Volt

Page 9-19: "It can be dangerous to leave the vehicle with the propulsion system running. It could overheat and catch fire. It is dangerous to get out of the vehicle if the shift lever is not fully in P (Park) with the parking brake firmly set. The vehicle can roll.

Do not leave the vehicle when the propulsion system is running. If you have left the propulsion system running, the vehicle can move suddenly. You or others could be  injured. To be sure the vehicle will not move, even when you are on fairly level ground, always set the parking brake and move the shift lever  to P (Park).
See Shifting Into Park on page 9-19."


A ce stade, je crois que le conducteur a compris qu'il faut mettre le levier de vitesse sur "P" quand il se gare...
 

ou alors, chez les Suédois :
" 2009 Saab 9-3 -Page 13: "Only one person per safety belt!"
This kind of limited thinking is probably why Saab went out of business."

____________________________________

Comment en sommes-nous arrivés là ?

A l'évidence, parce que le rédacteur a oublié de se mettre à la place de l'utilisateur final ; il n'a pas voulu le prendre en compte, avec son savoir-faire et son environnement.
 ("Comment ça, l'automobiliste sait déjà qu'à l'arrêt du véhicule, il faut positionner le levier sur P ? il le sait depuis sa première leçon de conduite accompagnée ? vous êtes sûr ?...")
Trop souvent, le rédacteur, une fois qu'il a  à peu près compris à quoi servait

le produit qu'il est supposé documenter, se prend pour Dieu-le-Père, ou même pire, pour Tarzan :


 "Moi, Tarzan-Rédacteur, expliquer que le bouton "ON" sert à mettre en marche. Toi, Jane-Utilisateur, appuyer sur le bouton"
______________________________________

Comment éviter ce travers ?

Un seul mot d'ordre : le minimalisme !

Pourquoi ? Parce que, parmi les principes du minimalisme, on trouve : "Adoptez l'écriture orientée tâches"  et surtout : "Analysez les tâches  de l'utilisateur dans son environnement" .

Par exemple, se souvenir que l'utilisateur peut être stressé, fatigué ou distrait (cf. l'article de Stephen Turbek ci-dessus).

Ah bon... Pourquoi ? 

Parce que l'utilisateur ne va pas ouvrir le manuel pour y trouver la rubrique : Le levier de vitesse au point 'P' (sur une voiture automatique), mais plutôt :

"Le témoin 'petit bonhomme' s'affiche en orange et clignote. Que faire ?"

01/07/2013

Minimalisme : les Dix Commandements

A mon humble avis, ceci est à mettre au-dessus de tout 
poste de travail d'un rédacteur technique :



1. Minimalist writing means including the least amount of content that is necessary for user success.

2. New users aren't interested in concepts.They want to jump in and try the product.

3. Minimalist writing means not offending the user's intelligence



________________________________________


4. Remove text about text.Must you tell the reader what the chapter contains, or can you get to the point?

5. Choose an action-oriented approach. Ensure that tasks follow an actual user workflow (a day in the life of...)

6. Include information that is more useful, well-suited to the task, and more action-oriented.

7. To slash verbiage, include fewer words, less description, and no useless information.



 ______________________________________

8. Give users a chance to be successful: get started quickly - jump into a task. 

9. Pay attention to what the user is perceiving,

 what is in their environment.


10. Don't focus on product specs and features; focus on what users need to do to be successful.



_____________________________________________________________
Ces règles sont extraites du webinar du 18 aout 2010, mené par JoAnn Hackos, sur le minimalisme et sponsorisé par Acrolinx [http://www.acrolinx.com/]