Les rédacteurs techniques créent différents types de documentation, par exemple, des manuels d’utilisation, de la documentation API, des guides ‘Comment faire’ et ainsi de suite. J’ai écrit un article sur la façon de rédiger un manuel d’utilisation, alors aujourd’hui je vais vous parler de la création d’un guide ‘Comment faire’.
Lorsque vous recevez une tâche pour créer un guide, votre première étape devrait être la planification. Voici ce que vous devriez faire :
Comprendre votre public cible
Lorsque vous commencez à écrire votre guide, vous devriez clairement comprendre qui est votre public cible. Quel est leur âge, quel est leur parcours et ainsi de suite. Cela définira le style de votre guide « Comment faire » au niveau le plus fondamental – la complexité du langage utilisé, le nombre de termes et de nombreuses autres caractéristiques.
Recherche sur le processus
Je vous recommande de lire l’expérience d’autres personnes dans la rédaction de guides « Comment faire ». Cela vous aidera à avoir une image claire du travail futur, et vous pourrez intégrer les approches des autres dans votre processus de travail. Par exemple, j’ai écrit sur le processus de rédaction technique d’Amrute Ranade, vous pouvez lire l’article ici : ‘Great Technical Writing Process’. Donc, vous pouvez également utiliser cette méthode pour faciliter votre rédaction technique.
Recueillir des matériaux utiles
Avant de commencer à écrire, recueillez des matériaux et des informations qui vous aideront à rédiger un guide ‘comment faire’. Il peut s’agir d’informations supplémentaires sur un produit, d’autres guides » mode d’emploi » sur des produits similaires ou autre chose.
Écrivez votre guide » mode d’emploi «
D’abord, créez un plan – il sera plus facile d’écrire un guide si vous le visualisez. Après tous ces préparatifs, il est grand temps de commencer à écrire. Pendant la création d’un guide, vous devez garder à l’esprit les conseils suivants :
- Écrivez en anglais simple pour parler le même langage que vos lecteurs.
- Votre langage doit toujours être concis (par exemple , ‘Sélectionnez l’option’ au lieu de ‘Vous devriez sélectionner l’option’).
- Créez des listes numérotées pour structurer les étapes si un utilisateur doit les compléter
- Ajoutez du contenu visuel comme des photos, des captures d’écran et des diagrammes.
- Coupez le contenu en sections à en-tête mais écrivez-les clairement
- Si vous voulez utiliser des blagues, faites attention : les gens risquent de ne pas vous comprendre
- Ajoutez des mini-TOC pour rendre les grands sujets plus lisibles.
Le conseil le plus essentiel est le suivant – les fautes d’orthographe et de grammaire sont inacceptables dans la documentation, alors vérifiez minutieusement votre guide. Voici une liste des meilleurs vérificateurs de grammaire gratuits. Vous pouvez également demander à quelqu’un d’autre de relire pour vous, ou lire vos propres étapes à l’envers pour vous assurer que votre écriture est claire et simple. Voici quelques autres ressources pour écrire une excellente documentation :
- Livres de grammaire pour les rédacteurs techniques
- Guides de style pour les rédacteurs techniques
Bien sûr, ce n’est pas tout ce qu’il y a à savoir sur la rédaction de guides » Comment faire « , mais ces conseils sont les plus essentiels, à mon sens. J’espère qu’ils vous aideront.
Bonne chance avec vos guides d’écriture !
.