Affichage des articles dont le libellé est mesurer qualité. Afficher tous les articles
Affichage des articles dont le libellé est mesurer qualité. Afficher tous les articles

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.