Instructions relatives aux messages d’erreur

Un message d’erreur est un texte qui s’affiche pour décrire un problème qui s’est produit qui empêche l’utilisateur ou le système d’effectuer une tâche. Le problème peut entraîner une altération ou une perte de données. D’autres types de messages incluent des confirmations, des avertissements et des notifications. Les instructions de cette rubrique sont destinées à vous aider à écrire des messages d’erreur clairs qui sont faciles à localiser et utiles pour les clients.

Les messages d’erreur mal écrits peuvent être une source de frustration pour les utilisateurs et peuvent augmenter les coûts de support technique. Un message d’erreur bien écrit fournit les informations suivantes à l’utilisateur :

• Qu’est-ce qui s’est passé et pourquoi ?
• Quel est le résultat final de l’utilisateur ?
• Que peut faire l’utilisateur pour l’empêcher de se produire à nouveau ?

La longueur du texte n’est pas un problème tant que le développeur gère correctement les tailles de mémoire tampon. Il est important que l’utilisateur dispose de toutes les informations nécessaires pour résoudre le problème. Si un message comporte plusieurs audiences, vous devrez peut-être fournir un texte distinct pour les administrateurs, les utilisateurs finaux et les développeurs.

Meilleures pratiques

Les méthodes suivantes permettent d’améliorer vos messages d’erreur :

• Évitez les conditions d’erreur. Si vous pouvez prédire qu’une erreur se produit lorsqu’un utilisateur effectue une action spécifique, réécrivez votre code afin que l’utilisateur ne puisse pas provoquer l’erreur.
• Écrivez un message d’erreur distinct pour chaque cause connue de l’erreur. N’utilisez pas de message générique unique pour expliquer chaque raison possible de l’erreur, sauf si vous ne pouvez pas déterminer la cause de l’erreur lorsqu’elle se produit.
• Indiquez clairement le problème et, s’il sera utile à l’utilisateur, expliquez ce qui a provoqué le problème. Dans la mesure du possible, remplacez les messages génériques des ressources de la table de messages système par un message détaillé spécifique au problème.
• Fournissez à l’utilisateur une solution au problème. Si la solution comporte plusieurs étapes, reportez-vous à une rubrique d’aide pour expliquer la tâche en détail.
• Affichez uniquement le nom du produit, du composant ou de l’Assistant dans la barre de titre du message. Cela permet à l’utilisateur de déterminer où se trouve le problème. Ne récapitulez pas le problème dans la barre de titre ou incluez le mot « erreur ».
• N’utilisez pas le jargon technique, utilisez la terminologie que votre public comprend. N’utilisez pas d’lang ou d’abréviations.
• Utilisez les boutons de commande appropriés, tels que OK, Annuler, Oui, Non et Réessayer. Vous pouvez utiliser des combinaisons de ces boutons. Les boutons Oui et Non doivent toujours être utilisés en combinaison et doivent toujours être précédés d’une question.
  • Pour arrêter une opération et fermer la boîte de message, utilisez le bouton Annuler.
  • Pour fermer une boîte de message, utilisez le bouton Fermer.
  • Pour fournir plus d’informations sur la cause de l’erreur, utilisez le bouton Détails.
  • Pour fournir plus d’informations sur la solution au problème, utilisez le bouton Aide.
  • Si une action utilisateur est incluse dans le message, utilisez le bouton OK pour fermer la boîte de message.
  • Oui et boutons Non doivent être utilisés en combinaison et doivent toujours être précédés d’une question.
• Si l’erreur est une erreur critique, écrivez-la dans le journal des événements .

Considérations relatives au style

• Utilisez des phrases complètes mais simples.
• Utilisez le présent tendu pour décrire les conditions qui ont provoqué le problème ou un état qui existe toujours. Vous pouvez utiliser des tensions passées pour décrire un événement distinct qui s’est produit dans le passé.
• Utilisez la voix active chaque fois que cela est possible. Vous pouvez utiliser la voix passive pour décrire la condition d’erreur.
• Évitez le texte en majuscules et les points d’exclamation.
• Ne sentez pas l’utilisateur en panne même si le problème est le résultat d’une erreur utilisateur.
• Ne pas anthropomorphiser. N’impliquez pas que les programmes ou le matériel peuvent penser ou se sentir.
• N’utilisez pas de mots ou d’expressions familiers. N’utilisez pas de termes qui peuvent être offensants dans certaines cultures.
• Ne composez pas plusieurs noms sans ajouter de préposition ou de sous-clause pour clarifier la signification. Par exemple, « Serveur d’annuaire du service LDAP du serveur de site » doit être remplacé par « Serveur d’annuaire pour le service LDAP du serveur de site ».
• Insérez des descripteurs avant un terme pour clarifier la signification de la phrase. Par exemple, « Spécifier InfID lorsque Detect est défini sur Non ». Doit être remplacé par « Spécifier le paramètre InfID lorsque l’option Détecter est définie sur Non ».
• Évitez le mot « mauvais ». Utilisez des termes plus descriptifs pour indiquer à l’utilisateur ce qui est incorrect. Par exemple, évitez les messages tels que « Taille incorrecte ». Au lieu de cela, indiquez à l’utilisateur quels critères utiliser lors de la spécification d’une taille.
• Évitez le mot « s’il vous plaît ». Il peut être interprété pour signifier qu’une action requise est facultative.
• Placez les mots à la fois dans l’index et pertinents pour la signification centrale au début de la chaîne de message.