Comment rédiger de manière concise ?

La rédaction technique doit être claire, cohérente et concise.

L’approche rédactionnelle  “Minimaliste” permet, grâce à un ensemble de règles et de bonnes pratiques, de réduire de façon conséquente les volumes de documentation en les recentrant sur les tâches que l’utilisateur doit effectuer. Il faut se mettre à la place de l’utilisateur et comprendre les objectifs qu’il souhaite atteindre. Une fois l’objectif identifié, il faut expliquer clairement et succinctement comment remplir cet objectif. Il ne faut pas décrire pourquoi l’utilisateur devrait faire cette action, mais comment il doit la faire.

Outre cette orientation « tâches », le minimalisme prône une réduction du nombre de mots par phrase et de phrases par documents, afin d’obtenir des contenus concis et clairs. Rédiger des titres courts et comportant un verbe d’action est également une bonne manière de guider l’utilisateur dans sa recherche d’information.

En adoptant ces deux grands principes, on obtient une documentation bien plus courte et donc plus facilement utilisable.

 

Les types de contenus à éliminer dans une documentation minimaliste

Voici quelques contenus pouvant être supprimés d’une documentation minimaliste :

  • introductions
  • « A propos »
  • phrases de transition
  • longues descriptions d’interfaces

Il est inutile de décrire une interface si on décrit correctement comment l’utiliser, c’est-à-dire les actions à faire dans cette interface.

 

Quelques bonnes pratiques pour alléger la documentation

Le but d’une écriture concise est d’utiliser les termes les plus pertinents. Une écriture concise n’a pas toujours le moins de mots possibles, mais elle a toujours les mots les plus pertinents. Lorsque seuls les mots les plus précis restent, le texte sera bien plus court et compréhensible.

L’introduction que vous venez de lire est-elle réellement nécessaire à ce stade du document ? Apporte-t-elle une information nouvelle par rapport à ce que vous avez déjà lu ? Dans une documentation minimaliste, nous n’aurions sans doute pas écrit cette introduction.

 

Remplacer les mots vagues par des mots spécifiques

La tendance à embellir et enrichir le texte est naturelle mais va à l’encontre d’une documentation concise. S’interroger sur l’emploi de chaque terme permet de ne choisir que les plus pertinents.

Exemple

Notre site web met à votre disposition de nombreux outils vous permettant de choisir le meilleur dentiste.

Peut s’écrire :

Notre site web propose des critères pour choisir le meilleur dentiste.

 

Eviter la redondance

Evitez les répétitions, comme dans les exemples du tableau ci-dessous :

Redundancy No redundancy
Tourner autour Tourner
Proximité proche Proximité
Résultat final Résultat
Dans le cas où si
Nouvelles innovations Innovations
Intérêt particulier Intérêt
Résumer brièvement Résumer

Attention aux termes superflus

Evitez d’écrire des mots qui n’apportent rien au texte comme par exemple :

please, really, quite, extremely, severely, welcome, simply, easy/hard/advanced (too subjective), desired, etc.

 

Utiliser la voix active

Utiliser la voix active dès que possible. Elle est plus courte et plus directe que la voix passive.

Exemples

N’écrivez pas :

La ligne de commande peut être ajoutée au fichier en cliquant sur l’icône.

Mais écrivez :

Pour ajouter la ligne de commande au fichier, cliquez sur l’icône.

 

Des titres courts avec un verbe d’action

Ecrivez des titres courts (pas plus d’une ligne), explicites et comportant un verbe d’action.

N’écrivez pas :

Ajout d’utilisateurs

Utiliser l’interface de connexion du programme A

Mais écrivez :

Ajouter des utilisateurs

Connecter le programme A au programme B