Guide : Comment devenir rédacteur technique

Tout d’abord, je dois être clair : la rédaction technique est une sphère unique qui réunit l’écriture et la technologie.

Si vous vous demandez si elle vous conviendra ou non, voici trois aspects fondamentaux de la profession de rédacteur technique.

1. Vous aimez travailler sur des textes. La rédaction technique ne consiste pas seulement à écrire, mais aussi à éditer, structurer, vérifier l’usage des mots, etc. Si vous avez un blog et que vous aimez écrire, cette profession est probablement pour vous.
2. Vous aimez enseigner aux gens. La documentation est comme un manuel qui fait naviguer les gens. Vous devez donc être capable d’écrire et d’expliquer les informations au public de manière claire et concise. Si vous avez travaillé en tant qu’enseignant, par exemple, cela peut vous aider à réussir.
3. Vous aimez apprendre quelque chose de nouveau chaque jour. Les rédacteurs techniques s’occupent toujours des nouveaux outils et dispositifs afin de décrire leur utilisation de manière claire pour les personnes non techniques, ils lisent les articles, livres et manuels de style pertinents.

Vous devez garder à l’esprit que la rédaction technique comprend différents types de documentation, par exemple, la documentation sur les caractéristiques d’un produit, la documentation sur les API, la documentation sur l’utilisateur, la documentation marketing, et bien plus encore. Chaque type de documentation requiert son propre ensemble de compétences. Toutefois, vous trouverez dans cet article des conseils qui seront utiles à tout rédacteur technique.

Compétences générales

Les compétences non techniques comprennent l’attitude, la communication, la pensée créative, l’éthique du travail, le travail d’équipe, le réseautage, la prise de décision, la positivité, la gestion du temps, la motivation, la flexibilité, la résolution de problèmes, la pensée critique et la résolution de conflits. Il est difficile de les améliorer mais elles sont essentielles pour les rédacteurs techniques – seuls des livres/articles pertinents et la pratique peuvent vous aider.

Je tiens à mettre l’accent sur une compétence non technique, la capacité à communiquer, car elle est très importante. Comme je l’ai mentionné dans mon billet invité intitulé « Du traducteur au rédacteur technique », ce travail peut être difficile pour les introvertis, car les rédacteurs techniques communiquent en permanence avec d’autres rédacteurs techniques, des propriétaires de produits, des experts en la matière et des développeurs. De plus, ils ne se contentent pas de communiquer, ils interrogent également des personnes qui connaissent mieux le produit. Comment cela se passe-t-il ? Lisez l’article intitulé « Comment réussir un entretien de rédaction technique ».

Compétences techniques

Ces compétences dépendent des exigences de l’entreprise. Toutefois, des cours peuvent vous aider à acquérir des compétences techniques primaires. Voici la liste des postes avec les ressources les plus efficaces pour apprendre :

Apprenez à connaître les instruments de développement de la documentation. Bien sûr, il y en a beaucoup, mais voici quelques aspects essentiels que vous devriez apprendre : qu’est-ce que MarkDown, RST, DITA, DocBook, AuthorIT, et n’oubliez pas un petit crochet par « docs as code ».

Apprenez le style de rédaction technique.

Ce style diffère du style conversationnel et du style commercial. Des manuels tels que le Chicago Manual of Style et le Microsoft Manual of Style peuvent vous aider à vous familiariser avec le style de rédaction technique. Ces manuels décrivent dans un grand nombre de cas comment utiliser correctement les mots et les phrases dans votre documentation. Pour vous entraîner, vous pouvez lire la documentation de Google, Microsoft, Amazon et réfléchir à la manière dont vous pouvez l’améliorer.
La réponse à la question « Comment devenir un rédacteur technique ? » est évidente : l’auto-développement : lisez des livres, suivez des cours, améliorez vos compétences personnelles et professionnelles.

Cette article est traduit de « Guide: How to Become a Technical Writer »
https://medium.com/@kesiparker/guide-how-to-become-a-technical-writer-f2c631586963

Bien qu’orientant vers des cours payants, j’ai trouvé ce article légèrement piquant. Son illustration en particulier.