dimanche 26 avril 2009

Faire des phrases simples et courtes

écrire,livre,informatique, phrase,courte,simpleL'écriture dans un livre informatique pédagogique doit être réalisée avec des phrases courtes et simples. Cela rejoint l'écriture pour le web. Plus les phrases sont longues alambiquées, plus l'utilisateur sera gêné et il devra alors relire une fois, deux fois la phrase avant de la comprendre. Tout cela nuit à la compréhension rapide d'un texte.

Voilà un exemple d'une phrase un peu trop complexe à mon goût, extraite d'un livre sur l'utilisation du logiciel Adobe Dreamweaver. C'est une explication sur la façon d'annuler l'application d'un style CSS :
"Pour annuler l'application d'un style, sélectionnez l'élément qui utilise ce style puis choisissez Format - Styles CSS - Aucun ou dans le menu déroulant Règle cible (ou Classe) du panneau Propriétés, cliquez sur Supprimer la classe ou dans le menu déroulant Classe cliquez sur Aucune".
Ouf ! Maintenant vous pouvez respirer !

Alors analysons cette phrase.

- Cette phrase comporte 46 mots ! C'est beaucoup trop. Pour moi, il faut compter 20-25 mots par phrase.

- La phrase contient trois fois le mot ou. C'est un indicateur très précis d'une phrase trop longue. A partir du moment où vous utilisez plusieurs fois le mot "ou", cela doit être un indicateur pour vous dire "Ma phrase est trop longue. Est-ce que je peux en faire plusieurs à chaque utilisation du mot ou". J'ajoute que l'utilisation du mot "puis", dans ce contexte, donne le même effet que le mot "ou".

- Le rédacteur écrit : "Règle cible (ou Classe)". Là c'est une erreur pédagogique. De quoi parle-t-on ? D'une Règle cible ou d'une Classe ? Cela ne peut pas être les deux en même temps. Si c'est l'un ou l'autre, il faut alors en expliquer le contexte d'utilisation : quand devons-nous utiliser une Règle cible ou une Classe ? A la lecture de cette phrase l'utilisateur est incapable de savoir quand il doit passer par Règle cible ou Classe.

- Puis nous lisons ensuite que cela ce passe dans le panneau Propriétés. Il eut fallut le dire avant ! Il faut toujours situer l'environnement d'utilisation avant de parler d'un élément d'interface de cet environnement (voir l'article Le chemin d'accès aux éléments d'interface).

Voilà ce que je propose comme correction :
"Pour annuler l'application d'un style, sélectionnez l'élément qui utilise ce style. Dans le panneau Propriétés, avec le bouton CSS actif, dans la liste déroulante Règle cible, choisissez Supprimer la classe. Toujours dans le panneau Propriétés, avec le bouton HTML actif, dans la liste déroulante Classe, choisissez Aucune."
J'ai ainsi trois phrases de 14, 19 et 17 mots.
Je n'ai pas utilisé les mots "ou" et "puis".
J'ai bien indiqué d'abord l'environnement dans le quel le lecteur va trouver les éléments décrits : le panneau Propriétés et après les éléments d'interface de ce panneau.
J'ai bien indiqué le contexte d'utilisation des deux possibilités pour annuler le style : avec le bouton CSS ou avec le bouton HTML actif.

mardi 14 avril 2009

Rappel à une fonction, une option

informatique, nom, rappel, écrire,livre, fonctionnalité, optionDans une page constituée de plusieurs paragraphes, le rédacteur peut évoquer plusieurs fois une fonction, une commande, une option donnée.

A la première évocation de cette fonction, il faut clairement la décrire et correctement la nommer, avec le même nom que dans l'application, le logiciel étudié.

Quand nous devons de nouveau évoquer cette fonction, il faut impérativement la nommer de la même façon que la première fois. Il ne faut surtout pas mettre en difficulté le lecteur en changeant son nom.

De plus, nous ne devons pas l'évoquer en utilisant un mot "passe-partout" dénué de sens, type : "cette option", "cette fonction" ou "cette commande". Le lecteur ne pourra pas facilement faire le lien entre ces mots "passe-partout" et le nom de la fonction que nous souhaitons évoquer de nouveau.

Il faut toujours faire appel à une fonction en l'évoquant par son nom utilisé dans l'application.

dimanche 5 avril 2009

Même mot pour la même action

A la rédaction d'un livre, il faut bien faire attention à toujours utiliser le même mot pour la même action.

action, informatique, mot, écrire, livreJe vais prendre un exemple bien concret que j'ai déjà vu dans un (des) livre(s) : le mot choisi pour désigner l'action d'utilisation d'un item d'un menu. Dans le même ouvrage, j'ai noté tous ces mots :
  • choisir,
  • cliquer,
  • sélectionner,
  • pointer,
  • activer.
Soit cinq mots différents pour la même action ! Cela nuit à compréhension de ce qu'il y a à faire. Pourquoi utiliser cinq mots différents pour la même action ? Quelle est la justification de ce manque flagrant d'homogénéité ? Le lecteur débutant peut facilement se perdre.

Donc soyons clairs : utilisez le même mot pour la même action. Vous gagnerez en simplicité et en compréhension pour vos lecteurs.