Good Docs – le point de vue d'une traductrice
Introduction¶
Les traducteurs fournissent des renseignements précieux pour rédiger une documentation claire et concise. Ils savent mieux que quiconque ce qui ne se traduit pas bien et ce qui embrouille le lecteur. Ce document examine certains de ces problèmes et met en évidence les meilleures pratiques en matière de création de documentation.
Du Point de vue de l'Auteur¶
La documentation de logiciel aide les utilisateurs à comprendre comment utiliser efficacement un logiciel particulier. Ils doivent comprendre ce qu’ils obtiendront au bout du compte et quels avantages ils en tireront. En même temps, lorsque vous créez de la documentation, vous la créez non seulement pour vous-même, mais également pour votre réseau et d’autres personnes susceptibles de la lire. D’autres personnes peuvent ne pas être originaires de pays anglophones. Cela signifie que l'anglais n'est pas leur langue principale. Pour cette raison, suivez ces règles fondamentales pour rendre votre documentation plus lisible pour tous les utilisateurs.
Utilisez un langage clair et simple¶
Vous n'avez pas la moindre idée de qui est vraiment l'utilisateur de la doc. Peu importe que cet utilisateur soit familier avec le domaine, qu'il soit un développeur expérimenté ou un débutant. Un langage clair et concis est la base d'une communication que le public ciblé peut facilement comprendre dès la première lecture. Il évite le jargon, les termes techniques et les constructions syntaxiques complexes au profit d'un langage plus simple et d'une structure claire. L'objectif est de s'assurer que le message est accessible et compréhensible pour un large public, peu importe son parcours ou son niveau de préparation à la lecture. Cela peut souvent être réalisé en simplifiant la structure des phrases ou des commandes à leur forme la plus simple.
Évitez les expressions idiomatiques, le jargon, les acronymes et les abréviations¶
Les expressions idiomatiques, le jargon, les abréviations et les acronymes peuvent être déroutants pour les lecteurs qui ne les connaissent pas, en particulier les locuteurs non natifs, les nouveaux employés ou les personnes externes à votre secteur d'activité spécifique.
Les idiomes sont souvent propres à une certaine culture et peuvent être difficiles à comprendre pour les lecteurs internationaux.
Le jargon comprend des termes spécialisés que seuls les experts dans un domaine particulier peuvent bien saisir.
Les abréviations remplacent les mots en anglais par des formes abrégées, mais ces abréviations n'existent pas toujours dans toutes les langues, ce qui rend la traduction difficile.
Les acronymes peuvent être ambigus, surtout s'ils ne sont pas définis lors de leur première utilisation.
Exemple :
❌ "Once you’ve got the hang of the dashboard, the rest is a piece of cake." Ici, l'auteur utilise des abréviations, de l'argot et des expressions idiomatiques.
✅ "Once you have learned how to use the dashboard, the rest is easy." En remplaçant les abréviations, l'argot et les idiomes par des mots associés à chacun d'eux, le sens devient plus clair.
Les expressions figuratives, comme celles dans les idiomes, sont souvent difficiles à traduire. Les rédacteurs techniques ou les traducteurs peuvent avoir de la difficulté à transmettre le même sens dans d'autres langues.
Exemple :
❌ "Let’s touch base next week to circle back on the open tickets."
✅ "Let us meet next week to review the unresolved support requests."
Le jargon et les acronymes peuvent être source de confusion, même au sein d'une même organisation, si leur signification n'est pas universellement connue.
Exemple :
❌ "Upload the CSV to the CMS and tag it according to SOPs."
✅ "Upload the CSV (Comma-Separated Values file) to the content management system and label it according to the standard operating procedures."
Remarque : si vous souhaitez utiliser des acronymes, définissez-les toujours la première fois : « Système de gestion de la relation client (CRM) ».
En éliminant les expressions idiomatiques et le jargon inutile, le sens de votre document devient plus clair. Remplacer les contractions par les mots qu'elles représentent signifie que les efforts de traduction dans toutes les langues sont plus faciles. Votre document est plus compréhensible pour le lecteur lorsque vous remplacez ou définissez des acronymes.
Utilisez la voix active¶
La voix active met l'accent sur l'auteur de l'action, indiquant clairement qui ou quoi est responsable de l'action du verbe.
Exemple :
Le système ouvre la boîte de dialogue dans laquelle vous devez remplir le formulaire.
Veuillez éviter d'utiliser la forme complexe, car elle peut être déroutante pour les lecteurs.
Pour en savoir plus sur l’utilisation de la voix active et l’importance de son utilisation, consultez cet avis et cette source externe.
Étapes spécifiques¶
Si vous avez des étapes spécifiques dans la documentation, séparez-les les unes des autres.
Par exemple :
Step 1 - Go to the section
Step 2 - Click the button
Step 3 - Complete the form
...
Étape N – enregistrement des modifications
Captures d'écran si nécessaires¶
Utilisez des captures d'écran appropriées si nécessaire. Cela signifie que vous n'avez pas besoin d'ajouter des captures d'écran partout, seulement aux endroits où vous avez besoin d'explications supplémentaires.
Utilisez des exemples¶
Si vous devez remplir le formulaire, donnez des exemples de la façon dont les utilisateurs peuvent le remplir. Mentionnez les limites s'ils en ont.
Conclusion¶
Rédiger une bonne documentation ne consiste pas seulement à la rendre techniquement précise, il est également très important de la rendre immédiatement compréhensible pour le lecteur. Ceci est particulièrement important lorsqu'un document technique doit être traduit dans d'autres langues. Dans ce document, l'intention de l'auteur était de mettre en évidence des techniques spécifiques pour rédiger une documentation de qualité et claire.
Author: Ganna Zhyrnova
Contributors: Steven Spencer