Un Bêtisier de Coquilles Documentaires

Négliger le processus de création de votre documentation peut avoir des conséquences surprenantes.

Considérez les quatre cas suivants :

1. Un important fabricant automobile produit un très beau cd-rom présentant son centre de conception et d'étude. Ce centre important est déjà une vitrine pour ce fabricant. Le cd-rom est destiné à valoriser encore ce pôle d'activité.
   Cependant, dans une des séquences en anglais, le présentateur – excellent sur tout le reste de cette présentation multimédia – se trompe de mot et laisse échapper un shit bruyant !

2. Un éditeur de logiciel connu fournit une documentation d'administrateur pour un serveur Internet. Toutefois, celle-ci comporte un exemple de code qui ouvrirait une brêche importante de sécurité s'il était mis en œuvre.

3. Un autre éditeur – de logiciel financier, cette fois – laisse passer dans un guide administrateur, un texte où une variable <VAR> est expliquée sous le titre la variable <VAR>=, une impossibilité mathématique, ce qui est gênant étant donné que les administrateurs ont forcément des compétences en mathématiques. En effet, ce serait comme si, au lieu de trouver une rubrique Chien dans un dictionnaire, on lisait Chien est suivi d'une définition comme le suivant : Le chien est est un des plus anciens animaux domestiques de l'homme.

4. Un éditeur de logiciel cfao fournit un glossaire avec la documentation d'un modeleur. Comme définition de trihèdre le document aurait dû donner celle utilisée dans la cfao, en l'occurrence une représentation symbolique des axes correspondant aux trois dimensions. Au contraire, la définition utilisée concerne les mathématiques pures et non appliquées : une figure comportant trois surfaces et non l'angle formé par l'intersection de ces surfaces. Si les utilisateurs du modeleur ne savaient pas ce qu'est un trihèdre, le texte mal adapté ne leur aurait jamais permis de bien en cerner le sens.

Ce qui relie les quatre cas

Qu'est-ce que ces cas ont en commun ? Dans chacun, par une inattention dans la chaîne documentaire, une erreur s'y glisse et reste inaperçue. Le résultat : l'image de marque du fabricant est atteinte. Quel lecteur retiendra les très belles informations contenues dans le cd-rom du fabricant d'automobiles ? Ce sera le seul gros mot qui écrasera tout le reste dans sa mémoire. Jolie association pour un produit, n'est-ce pas ?

Aucun administrateur ne pourra prendre au sérieux les promesses d'un éditeur de logiciels serveur s'il s'aperçoit d'une erreur dans un exemple de code, que ce soit avant ou au cours de la mise en œuvre du produit. Qui plus est, dans ce dernier cas, il s'expose à des risques d'intrusion.

Conclusion

Attention ! Une documentation n'est pas une fin en soi. C'est une partie importante de l'expérience de l'utilisateur de votre produit ainsi qu'une extension de votre marketing technique. À condition qu'elle soit réellement orientée utilisateur.

Pour savoir comment Open Globe peut vous éviter des coquilles préjudiciables à votre image de marque, contactez-nous en utilisant le formulaire de la page Contacter.