Comment créer des documentations conviviales avec un Anglais Technique Simplifié

How To Create User-Friendly Documentations With Simplified Technical English

L'Anglais est l'une des langues les plus utilisées dans la rédaction technique. Mais la langue anglaise est complexe - riche en idiomes, phrases verbales, figures de styles, synonymes, mots et termes ambigus pouvant embrouiller les locuteurs secondaires, et même natifs. C'est une des raisons pour lesquelles les utilisateurs ne lisent pas vos manuels.
En documentant, la plupart des rédacteurs techniques estiment ardue la tâche consistant à communiquer les termes techniques complexes en des mots, phrases et instructions très simples et faciles à comprendre. Dans la plupart des cas, l'effort du rédacteur technique est mesuré aux avis des utilisateurs.
Ainsi, pour rendre les documentations techniques comme les manuels d'utilisation, fichiers d'aide, guides de sécurité, etc. plus faciles à comprendre et faciles à utiliser, l'Association des industries aérospatiales et de défense de l'Europe (ASD) a développé l'Anglais Technique Simplifié (STE), également connu sous l'appellation ASD- STE100 ou la technique Thumbs-up.

Le STE est avant tout important pour l'écriture de contenu clair et sans ambiguïté, en particulier pour les instructions d'utilisation comme les manuels de maintenance, guides d'utilisation, guides de sécurité et autres documentations d'aide. Vous pouvez apprendre comment écrire un excellent manuel d'aide avec l'approche de l'Anglais Technique Simplifié.

Comment utiliser l'Anglais Technique Simplifié (STE)

La technique Thumbs-up comporte trois étapes clés pour l'utilisation de l'Anglais Technique Simplifié. Ces étapes sont :

  1. Déterminer les informations pertinentes et supprimer celles qui ne le sont pas.
  2. Vérifier les significations de mots approuvées dans le dictionnaire STE en ligne
  3. Changer les phrases en utilisant le langage simple et facile à comprendre, suivant les suggestions du dictionnaire STE.

1. Déterminer les informations pertinentes et supprimer celles qui ne le sont pas

De nombreux contenus didactiques comme les avertissements et descriptions de tâches contiennent fréquemment des informations non-pertinentes sur la façon dont les utilisateurs peuvent accomplir une tâche.

Par exemple : Comment installer la version 2.11 du logiciel rapidement, en quelques minutes et sans perdre de temps.
Peut-être changé en : Comment installer la version 2.11 du logiciel rapidement.
Supprimer l'autre partie de la phrase "rapidement, en quelques minutes et sans perdre de temps" ne modifiera pas les instructions de quelque manière que ce soit.

La première étape de la technique Thumbs-up est la suppression de toute information non-pertinente, en ne laissant que les pertinentes. Un moyen simple pour identifier les informations non-pertinentes est de vous poser cette question simple mais logique : "L'utilisateur a-t-il vraiment besoin de cette information ou ce mot pour accomplir cette tâche ?" Si le retrait d'un mot ou d'une phrase ne modifie pas la façon dont la tâche est exécutée ou complétée, vous n'avez pas besoin de ce mot ou de cette phrase.

2. Vérifier les significations de mots approuvées dans le dictionnaire STE en ligne

Le dictionnaire en ligne STE contient des définitions de mots approuvées qui facilitent la compréhension de documentations techniques aux utilisateurs. En documentant, il est probable que vous utilisiez des mots dont vous n'êtes pas certains que les utilisateurs saisissent le sens voulu.

Vous pouvez utiliser le Dictionnaire STE en ligne comme guide de vérification afin de vous assurer que les documentations soient conviviales. L'utilisation de mots approuvés et non approuvés est résumée dans les quatre règles de rédaction suivantes :

  1. N'utilisez que les formes de verbes et d'adjectifs présentes dans le Dictionnaire STE.
  2. Gardez la signification approuvée d'un mot dans le Dictionnaire STE. N'utilisez pas le mot avec un autre mot ou une autre signification.
  3. Choisissez uniquement les mots dans le dictionnaire.
  4. Utilisez les mots approuvés uniquement dans le cadre de discours.

Pendant la rédaction de votre documentation, envisagez l'utilisation d'un OCA tel que HelpNDoc qui contient de multiples dictionnaires pour s'assurer que le contenu soit aussi parfait que possible.

3. Changer les phrases en utilisant le langage simple et facile à comprendre, suivant les suggestions du dictionnaire STE.

Cette étape concerne l'application pratique de la première étape de l'Anglais Technique Simplifié. Tout d'abord, vous devrez déterminer les informations pertinentes de votre documentation et les conserver. Supprimer toutes les informations non-pertinentes. Il y a deux choses que vous pouvez faire pour convertir les phrases de vos documentations en STE.

D'abord, recherchez vos phrases sous "Exemple approuvé" dans le Dictionnaire STE. Il existe 66 Règles d'Ecriture, bien que vous puissiez ne pas les connaitre toutes, vous pouvez copier et coller les phrases communes similaires de cette colonne ou imiter leur structure pour créer les propres.

Ensuite, présentez l'information de base, traduisez-la dans un langage simple et facile à comprendre. Mais rédiger une documentation dans un langage contrôlé nécessite une approche fonctionnelle. Dans la pratique, il existe des règles spécifiques pour les fonctions de texte, à l'instar des instructions, résultats ou messages d'avertissement. Voici deux excellents exemples de règles de langage fonctionnelles et contrôlées :

Exemple 1:
Fonction de texte : Instruction
Modèle : Verbe + article + objet + ponctuation
Exemple de texte : Cliquez sur le bouton.

Exemple 2:
Fonction de texte : Résultat
Modèle : Article + objet + verbe (présent) + ponctuation.
Exemple de texte : La fenêtre Rapport de Dépenses s'affiche.

Les deux exemples présentent l'essentiel de l'information, l'exprimant dans un langage très simple et facile à comprendre. Gardez cela à l'esprit lorsque vous modifiez vos phrases pour vous conformer à STE.

Amusez-vous en documentant !