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

22/11/2014

Cachez cette Short Description que je ne saurais voir !...

Eliminons et nettoyons est le mot d'ordre de nombreux rédacteurs sur le point de migrer leur documentation vers la norme DITA.

C'est ainsi qu'à la conférence DITA Europe 2014 à Munich une participante expliquait que, pour réduire le volume de leur documentation, ses clients désireux de passer au minimalisme... commençaient par éliminer la "Short Description" (un des éléments essentiels du standard DITA)


SACRILEGE !
_____________________________________ 
 
En effet, selon les experts Michelle Carey (co-auteur du guide "DITA Best Practices) et Kristen Eberlein, la "short description" est la partie incontournable d'un bon document procédural. Après le titre de la procédure, il faut OBLIGATOIREMENT une "Short Description".


Dans la <ShortDesc> on expliquera le POURQUOI de la tâche incluse dans la procédure. Il s'agit de préciser à l'utilisateur quel est l'intérêt pour lui de suivre ces étapes. Il décide ensuite s'il veut poursuivre la lecture et si cela correspond à son besoin d'information.

Tony Self, auteur du DITA Style Guide, détaille tout cela dans son article  "Reflections on Writing Short Description".



Par ailleurs, au moment de la recherche sur le Web, avez-vous remarqué que, sous le titre
de la procédure qui s'affiche, apparait un petit paragraphe, qui, s'il est bien ciselé, présente le condensé de la procédure ? Et bien oui, c'est la "Short Description" ! ...alors, ne la cachons pas ! 

Ne jouons pas au Tartuffe s'écriant  "Cachez ce sein que je ne saurais voir" ...

Montrez-nous la "Short Description" !

 Résumons : si la "Short Description" affiche l'intérêt que représente pour l'utilisateur la procédure annoncée (par le titre), ce n'est certainement pas cela qu'il faut éliminer lorsque l'on cherche à réduire  la masse de documentation. Au contraire. C'est cette partie qui va indiquer à l'utilisateur si cette rubrique correspond à ce qu'il cherche...

Le mot est tombé : "CHERCHER" (et surtout trouver...).  L'utilisateur ouvre le manuel pour chercher une info précise. Comment l'aider à trouver cette info ? En lui fournissant :

  • une table des matières précise, bien découpée, basée sur des titres parlants (honnissons les "Introductions", "Généralités", "A propos de..."), 
  • un index bien pensé 
  • et une Short Description pour voir immédiatement la "substantifique moelle"  de la procédure qu'il s'apprête à lire.

Ce n'est donc pas cela  que le rédacteur formé au minimalisme va supprimer, au contraire. En réalité, il s'agit d'une excellente mise en application du 4e principe du minimalisme :  (l'utilisateur) "read to locate some information"  selon Dr. Hans van der Meij. Pour la trouver, l'utilisateur dispose du titre, mais aussi de la Short Description.

_____________________________________

Si vous ne souhaitez pas embourber votre équipe de documentation dans le fatras du


(mauvais) minimalisme (*), jetez un oeil sur le programme d'un atelier de formation "Créer l'information dont on a vraiment besoin". 



_____________________________
(*)  tout le monde en parle, mais personne n'a pris la peine de vérifier...

28/08/2014

Section "Troubleshooting" ...Comment faire ?

Un chapitre "Troubleshooting" dans ma documentation ? Reprise sur erreur avez-vous dit ?...
 
 C'est le principe n° 3  du minimalisme : "Support error recognition and recovery". Il s'agit d'aider l'utilisateur à retomber sur ses pieds, alors qu'il a fait une erreur.
Pour faciliter le retour sur la bonne voie, le rédacteur a deux options: 
  •  donner la résolution du problème exactement là où a pu se déclencher l'erreur, c'est-à-dire dans la procédure,
  • créer une section "Résoudre les problèmes".
Intervenir directement dans la procédure répond exactement à la recommandation de Dr. van der Meij : 
"Provide error information when actions are error-prone or when correction is difficult"
Ce principe de la correction d'erreur est complété par Dr. JoAnn Hackos, (webinaire du 27.08.2014). Il s'agit d'aider les utilisateurs à détecter, définir, diagnostiquer et corriger les problèmes.

L'essentiel est d'indiquer : 
  • la cause du problème
  • le moyen de résoudre le problème
A ne pas négliger non plus : donner -à l'utilisateur- la possibilité de trouver rapidement le chapitre "Troubleshooting" !



 "Troubleshooting" : le modèle______  


Le comité DITA OASIS a mis au point, dans sa version 1.3, le modèle de rubrique "Troubleshooting".  Aucune raison de ne pas s'en inspirer !

En prenant l'exemple de l'article du 3 juillet 2014 (Comité DITA OASIS), on va repérer les éléments de ladite rubrique : Title, Short Description, Condition/Situation, Cause, Remedy


Mise en pratique

 ________________________ORIGINAL____________________________
Titre: System will not turn on


ShortDesc: Everything looks right, but the system still does not start


Condition/Situation: The system is plugged in, the power switch is on, but the system will not start.


Cause: The problem is usually due to power not being supplied to the system through the electrical outlet. Often, a circuit breaker has been tripped so that no power is available at the outlet.


Remedy/Solution: 
WARNING
If you don't not know how to reset circuit breakers, do not attempt ot fix this problem. Instead, find somebody who is qualified to do this for you.

1. Turn the system power switch to OFF
2. Reset  the breaker
3. Turn the system power switch on O
N.

The system turns on.

_______________________
VERSION OPTIMISEE______________________
On peut optimiser le contenu, tout en gardant la structure :

Titre : System will not start

Mini Desc : If the system does not start, it is probably due to the circuit breaker. It is recommended to have a qualified professional reset the circuit breaker.

Situation : The system is plugged in, the power switch is on, but the system will not start.

Cause : Power is not supplied to the system through the electrical outlet. A circuit breaker has probably been tripped that blocks power distribution.


Solution :
1. Make sure you have the necessary skills to reset the circuit breakers

2. Turn the system power switch to OFF
3. Reset  the breaker
3. Turn the system power switch on ON.



______________________

COMMENTAIRES

  •   En anglais, nous avons l'élément "Condition" qui, IMHO, peut porter, en français, à confusion. On serait tenté par une traduction littérale et cela mènerait inévitablement à de grosses bourdes. Il ne s'agit pas de donner les conditions pour que le système ne marche pas, mais bien de clarifier la SITUATION de blocage dans laquelle l'utilisateur se trouve.
  •  La version originale inclut un "Warning" qui s'avère inapproprié. Il n'y a pas de danger physique (ou, tout au moins, il n'est pas indiqué), donc pas d"AVERTISSEMENT". 
Rajouter des avertissements dans une rubrique "Troubleshooting" va mener vers le sac de noeuds dans lequel l'utilisateur ne retrouvera pas les instructions nécessaires à sa reprise sur erreur. 
L'information contenue dans cet avertissement peut trouver sa place dans une instruction et, comme démontré ci-dessus, dans la "Short Description".

Chaque rubrique  "Résolution des problèmes" s'insère  fort bien dans un chapitre "Résoudre les problèmes" qui, avec un titre parlant, facilite la recherche.

L'insertion d'une mini-rubrique "Problème ?" dans la procédure, sera détaillée dans un autre article du blog...

_____________________________________________________

Poursuivre l'exercice ?

Venez en parler lors de la conférence User Assistance Europe qui se tiendra les 9 et 10 juin 2016 à Budapest où il sera question de... troubleshooting !



24/06/2014

Combien d'argent ai-je jeté par les fenêtres aujourd'hui ?

En matière de documentation produits, voici trois pistes pour brasser de l'air et dépenser à tour de bras :









  • passer 4 h 45 à rédiger le chapitre "Généralités" ... que l'utilisateur ne va pas lire.

  • __________________________________________
    Suzie-la-Terreur
    Et voici Suzie-La-Terreur (terreur des équipes de rédaction) pour qui la documentation
    technique, c'est comme l'oie que l'on promène dans les rues de New York : décalée, rutilante, humoristique, hors contexte, futile... risible !

    Son manuel sur papier glacé est futile, décalé, risible et inutile parce qu'il ne répond pas aux questions précises telle que "comment faire pour modifier les paramètres sans perdre mes enregistrements précédents" que se pose l'utilisateur.

    Par contre, ledit manuel se contente de ressasser les évidences. Sous Software Update, il est effectivement impératif d'ajouter qu'il faut avoir installé la version précédente avant de mettre à jour !



    Aucune raison  de se pavaner dans les salles de réunion avec le manuel de 450 pages  si l'utilisateur s'en sert comme rehausseur de siège !

    Bien sûr, Suzie-et-son-oie-à-New-York (Photo de Ruth Jacobi, 1928) nous plaisent beaucoup  : elles feraient un excellent fond d'écran . 
    __________________________________________
    Suzie-la-dispendieuse
    Transposée dans le monde de la rédaction technique, Suzie ne génère qu'une chose : REJET ! Cette documentation est coûteuse parce qu'inexploitable : aucun utilisateur ne va y trouver rapidement la réponse à sa question.  Ce faisant, Suzie a tout fait pour détruire l'image du métier et confirmer que la documentation ne sert à rien, sauf à générer des coûts inutiles !
     En cela, elle se rapproche du rédacteur de Dany Boon (celui qui explique en 5 langues comment démarrer le micro-ondes)
    ___________________________________________

    Comment s'en sortir ? Où est l'alternative ?

    Ne donner à l'utilisateur que ce dont il a besoin !... c'est la base du "Minimalism: creating information people really need"



    Il s'agit d'une formation exclusivement basée  sur la _pratique_: vous apportez vos
    documents et vous repartez avec VOTRE DOCUMENTATION passée au crible du minimalisme.



    07/06/2014

    Minimalisme: principe n° 2 "L'outil intégré dans la tâche"

    Oui, mais, ... qu'est-ce que cela veut dire au moment de la conception de la documentation ?


    Anchor the tool in the task domain

    Disons : "l'outil doit être considéré par rapport à la tâche"
    Dr. Hans van der Meij nous l'explique : 
    • For most users, an application is a tool they want to use to achieve objectives in their own task domain. 
    • The tool is merely a means; it is almost never an end in itself. 
    • The designer should therefore select or design instructional activities that are real tasks.

    Les vraies tâches : comment les approcher ?

    Il s'agit, entre autre, de prendre en compte l'utilisateur (et non pas l'outil) avec :

    • son environnement de travail / ses conditions de travail 
    • son savoir-faire / sa formation initiale et continue 
    ________________________________________

    Sergio, le monteur

    Par exemple, Sergio,expert monteur de lignes électriques, aimerait beaucoup que la documentation fournie pour les nouveaux boîtiers de raccordement soit adaptée à
    son savoir-faire existant, mais aussi à ses conditions de travail.

    Pour cela,  le rédacteur prend soin de fournir un plan détaillé des circuits des boîtiers, convaincu que cette illustration sera utile au monteur.
    Pour que ce soit clair, il le fait imprimer au format A3, le tout bien plié dans le manuel papier au format A4. Beau travail.

    Au moment de grimper au poteau, Sergio, de son côté,vérifie son équipement : vêtements de protection, chaussures de sécurité, casque, gants de protection, harnais, outillage et
    "grimpettes".

    Question : où va-t-il maintenant glisser le manuel d'installation? 
    Ingénieux, Sergio, vient de trouver une place dans une poche externe du pantalon.

    Et c'est parti pour l'ascension avec grimpettes !

    ________________________________________

    Le rédacteur a pensé à tout... sauf à l'essentiel

     Environnement de travail

    En équilibre sur son poteau, Sergio veut vérifier un détail du montage du boîtier. 

    • Comment atteindre l'information pertinente si son environnement de travail joue les trouble-fêtes ? 
    • Comment déplier le schéma de montage au format A3 par grand vent, sous la pluie, ... ou parce qu'il doit impérativement porter des gants ?
    Retour à la case départ : le manuel est inutilisable dans les véritables conditions de travail.

    Savoir-faire : formation initiale, formation continue

    Mais, fichtre, pourquoi est-ce que l'installateur ne lit pas le manuel si bien ciselé pour lui ?


    Et bien tout simplement parce qu'il se base sur son savoir-faire. Ce n'est pas dans VOTRE manuel qu'il apprend le métier. C'est au moment de sa formation initiale.

    Ensuite, il conforte son savoir par transmission par les "anciens". Dans le cas de Sergio, ils sont toujours deux monteurs pour une installation. La transmission de savoir se fait donc sans intermédiaire et in situ.

    Donc, il n'est pas nécessaire de lui expliquer les dangers de l'électricité à haute tension ! Il le sait mieux que le rédacteur et depuis son premier cours !

    En formation continue, nombreuses entreprises chargés de travaux dangereux organisent des réunions régulières  avec tous les opérateurs pour analyser une ou deux procédures  du manuel.
    _____________________________________________________
    Alors que faire ? 
    Le rédacteur doit-il tout simplement abandonner le traditionnel "Guide d'installation" 
    inutilisable en situation réelle ?

    Non, il optera plutôt pour un manuel basé sur le minimalisme en :
    • prévoyant des fiches cartonnées pour les infos indispensables
    • envisageant la migration des fiches sur support mobile  
    • proposant des supports de formation continue (gamification, bandes dessinées, videos, etc.


    ... et en évitant de démarrer une section du manuel par "1ère étape - coupez le courant". Sergio le sait depuis longtemps !
    - 

    26/05/2014

    La documentation minimaliste ?... un mauvais plan !

    La documentation dite minimaliste ne m'intéresse pas parce que :

    • je n'y connais rien
    • ça n'a pas été inventé chez nous
    • c'est du mauvais travail. Il faut TOUT dire à l'utilisateur
    • mon boss ADORE les gros manuels. Je suis payé à la page...
    • le département de documentation n'a pas de problèmes de budget




    • les utilisateurs ? Je m'en fiche ! Ils n'ont qu'à lire le manuel de A à Z
    • il est hors de question de changer de méthode de rédaction. On a toujours fait comme ça
    • vous parlez DITA ?
      Publication sur tablette ? Responsive design...? Foutaises ! Il n'y a qu'une seule doc, c'est la documentation papier !

    • vous voulez mixer Twitter et la documentation technique ?...  Profonde aberration ! 

    On ne se la joue pas "Première Dame", chez nous !







    • l'overdose d'avertissements et de notes vous gène ? 


    C'est inévitable, parce que l'utilisateur est un crétin !
    Il faut tout lui répéter !








    Pour plus d'information sur le montage d'un atelier "minimaliste", contactez [flacke@orange.fr]

    21/05/2014

    Minimalisme ? pas chez nous !

    "Nous fournissons un travail sérieux, nous ! Nous ne rechignons pas devant l'ampleur de la tâche : nous fournissons la totalité de l'information ! Un travail vraiment complet... sinon rien !

    Le minimalisme est réservé aux rédacteurs à mi-temps, ceux qui veulent un travail "quick and dirty" !


    Alors, vous préférez l'infobésité ? 

    ...disons un beau manuel de 800 pages ?

    Mais vous, cher rédacteur, quand avez-vous ouvert et utilisé un manuel de 800 pages ?

    Rappelez-vous l'excellent sketch de Dany Boon qui tente de lire -en première mondiale- un manuel utilisateur en entier ...


    Complète votre documentation ?

     ... mais est-elle utile ?
    Effectivement, 400 pages seulement pour votre guide opérateur paraissent bien digestes. C'est bien ! Mais savez-vous comment votre utilisateur va chercher (et trouver) l'information qu'il recherche ? 

    Avez-vous remarqué que Nokia produit la totalité de sa documentation selon les 4 principes du minimalisme ?

    ...à votre avis, vos utilisateurs ne méritent pas la qualité Nokia ?

     Secteur réglementé

    Vous rejetez le minimalisme parce que vous intervenez dans le nucléaire ? dans le médical ? dans l'aéronautique ? ... Vous souvenez-vous QUI vous a démontré que les règles du minimalisme étaient incompatibles avec votre secteur ?


    Branchez-vous sur l'enregistrement du  webinaire organisé par la STC France le mardi 27 mai 2014 ! Vous aurez la présentation et les échanges.


    Formation par atelier interactif

    Le prochain atelier aura lieu les 29 et 30 septembre 2014 à Liège (BE)



    20/03/2014

    Jeter aux orties les Vues d'ensemble et Introductions ?

    Savez-vous ce que pensent les utilisateurs de vos sections "Vue d'ensemble", "Généralités" ou "Introduction" ?

    RIEN ! Ils négligent, ils rejettent, ils ignorent... Ils ne lisent PAS toutes ces formes de préambules (les ingrats !)

    Alors, pourquoi les inclure ? Pourquoi obliger les utilisateurs à feuilleter une dizaine de pages avant d'arriver à l'essentiel : "comment faire pour..."

    Voici ce qu'en pense notre collègue Larry Kunz (extrait d'un message sur Twitter) :



    Alors, si le consommateur n'a pas besoin d'une Vue d'Ensemble avant de commander une bière, est-ce que l'utilisateur a besoin d'une introduction avant d'utiliser le produit ?


    Superfétatoire, l'introduction ?

    Voici un exemple d'une introduction superfétatoire (il s'agit d'un manuel utilisateur d'un logiciel de création documentaire) :
    Introduction
    Ce guide est la documentation de la chaîne éditoriale XYZ. Elle regroupe :

    • Une introduction sur les fonctionnalité de XYZ et l'apport d'une chaîne éditoriale dans la rédaction des documents d'aide utilisateur d'un logiciel
    • Une présentation de l'interface utilisateur d'XYZ
    • Les procédures fondamentales d'utilisation de l'application
    Donc, l'utilisateur a fait l'acquisition du produit XYZ. Normalement, à ce stade, il sait ce qu'il a acheté et a une certaine connaissance de ce qu'il peut faire avec ce produit. Avec le logiciel XYZ, il ne va pas chercher à faire du café ni à démontrer l'universalité de la théorie de la relativité...

    Alors que le titre du manuel est "Documentation utilisateur de XYZ", est-il nécessaire de rappeler en page 8 : "Ce guide est la documentation utilisateur de..."

    En introduction, on explique ensuite que, dans le manuel, il y a une introduction sur les fonctionnalités...  Introduction seulement ? Et le coeur des fonctionnalités, il est où ?


    Présentation ... pour quoi faire ?

    Après l'introduction à l'introduction, nous avons la  Présentation ... non pas du logiciel,
    mais de l'interface. Intéressant. L'utilisateur a déjà l'écran en face de lui et maintenant on lui explique ce qu'il a devant les yeux. "L'option IMPRIMER sert à imprimer", "L'option EDITER sert à éditer", etc.

    Sachant que les PC grand public sont arrivés en Europe dans les années '90, on est tenté de croire que, depuis le temps, l'utilisateur a assimilé les bases d'un travail avec l'interface.

    Voyez ce qu'en pensent les spécialistes de l'ergonomie des interfaces graphiques :



    Pour terminer, nous découvrons (enfin !) les procédures fondamentales (question de la béotienne que je suis  : quand elles ne sont pas fondamentales, les procédures, que sont-elles ?) ...et là, l'utilisateur est ébahi : dans un manuel utilisateur il trouve des PROCEDURES ! Quel bonheur !... c'est ce qu'il recherche depuis 15 minutes !


    Le titre ...

    Tout aussi édifiant, parfois, est le titre.

    Ce grand industriel allemand, fabricant d'antennes de transmission sans fil par micro-ondes
    (WiMAX) indique, en titre de son guide :"Safety precautions for User Guide". Oui, vous avez bien lu : "Précautions de sécurité pour le guide utilisateur".

    ... nous les professionnels de la rédaction le savons pertinemment : un manuel utilisateur est un OBJET DANGEREUX ! On ne peut travailler qu'avec moultes assurances-vie.

    A votre avis, n'est-il pas temps de cesser de produire de l'information inutile et de revoir nos contenus ? 
    ________________________________
     
    Le prochain atelier "Minimalisme : créer l'information dont on a vraiment besoin" aura lieu les 15-16 décembre 2014 à Vélizy (Paris) chez NMJ Services. Les inscriptions sont ouvertes !



    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 !

    17/02/2014

    Le minimalisme expliqué par un Ch'ti (*)

    Qui ici a lu une fois dans sa vie un mode d'emploi en entier ?


    C'est la question posée par l'acteur Dany Boon dans son interview d'un éminent rédacteur technique.

    L'acteur compatissant analyse avec le rédacteur technique (au bord du désespoir : 60 ans
    de rédaction et personne n'a jamais lu un seul manuel en entier !..) le contenu d'un de ses guides utilisateurs. Celui destiné à l'utilisateur d'un micro-onde.


    Après le "Démarrage rapide" (3.07e minute), on passe allègrement au chapitre 2. 
    Il y est clairement indiqué :

    "Mettre les aliments à réchauffer à l'intérieur du micro-ondes"

    _____________________________________________________________________

    Ne donner à l'utilisateur que ce dont il a besoin !

    C'est le principe de base du minimalisme : uniquement ce dont l'utilisateur a besoin. 
    En effet, l'utilisateur du micro-onde a-t-il besoin d'apprendre, dans un manuel en 5 langues, que, pour réchauffer des aliments, il faut les déposer à l'intérieur de l'appareil
    (3.47e min. de la vidéo) ? Pensez-vous qu'un utilisateur normalement constitué aurait envie de mettre son frichti à l'extérieur de l'appareil ?

    Pourquoi alors rappeler à l'utilisateur ce qu'il sait déjà ? Est-ce vraiment l'essentiel du métier de rédacteur technique ?... 
    ________________________________

    Remettre en question l'intelligence de l'utilisateur ?

    Arrêtez-vous (4.13e minute) sur l'instruction lue par Dany Boon : 

    "Pour mettre en route le micro-onde, appuyez sur la touche Start" 

    Nous sommes d'accord, seul un Ch'ti pouvait commenter -en aparté, soit- "On n'est pas des c..."  Mais est-ce vraiment nécessaire de noircir du papier pour asséner une telle évidence ? 

    A ce sujet, observez un bout de chou de 3 ou 4 ans à qui l'on vient de 
    montrer comment écouter ad libitum sa ritournelle préférée sur une tablette. Il ne sait ni lire ni écrire, mais il fait le lien entre le bouton START et le plaisir de l'écoute... sans bien entendu savoir qu'il s'agit d'un bouton START et sans manuel utilisateur !

    Appliquons donc un des principes du minimalisme : respectons le savoir-faire de l'utilisateur, ne nous moquons pas de lui !

    _________________________________________________

    Fonctions, multifonctions et fonctionnalités


    Si, un jour de grand désespoir, vous étiez tenté de démarrer un chapitre "Les multifonctions" , n'hésitez pas à  écouter le passage idoine de la vidéo. Cela risque peut-être de doucher quelques ardeurs malvenues...

    Que faire alors des "Multifonctions" ?
    En minimalisme, on ne parle JAMAIS de fonctions, mais TOUJOURS de l'ACTION que doit effectuer l'utilisateur pour accomplir une tâche (et ainsi atteindre son objectif).
    On ne parlera pas de la "Multifonction décongélation programmable", mais de "Programmer la décongélation des aliments".


    Conclusion ?  Vous avez raison, il faudrait inviter Dany Boon à présider le prochain congrès des rédacteurs techniques ! Il a tout compris ... 

    (*) Qu'est-ce qu'un Ch'ti ?

    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.