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...

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 !