Comment devenir rédacteur technique – Un guide pour les développeurs

Article original : How to Become a Technical Writer – A Guide for Developers

Être un développeur de premier ordre était mon rêve – jusqu'à ce que je réalise que je pouvais combiner ma passion pour l'écriture avec mes connaissances techniques pour gagner ma vie. C'est exact : je parle de devenir rédacteur technique.

Et si vous êtes développeur, vous êtes peut-être bien placé pour vous lancer dans la rédaction technique si cela vous intéresse.

Les développeurs ont beaucoup de connaissances sur des sujets comme Git, Markdown, les langages de programmation et les IDE qu'ils peuvent utiliser pour enseigner aux autres. Et comme ils ont travaillé avec ces outils et technologies eux-mêmes, ils peuvent souvent rédiger de la documentation avec une approche centrée sur l'utilisateur.

C'est aussi assez lucratif d'être rédacteur technique, avec un salaire moyen aux États-Unis de 76 432 $ par an. Cela en fait une carrière viable pour subvenir à vos besoins et à ceux de votre famille.

Heureusement, j'avais des exemples de rédaction technique pour montrer mes compétences en écriture lorsque j'ai décidé de lui donner une chance. Mon amour pour l'écriture m'a offert un portfolio de rédaction technique prêt à l'emploi et a facilité mon changement de carrière.

Mais ce n'est pas le cas pour tout le monde et les gens me demandent régulièrement des conseils pour commencer la rédaction technique et gagner de l'argent grâce à elle. Je compile donc toutes les choses qui m'ont aidé à passer à la rédaction technique dans cet article.

Qu'est-ce que la rédaction technique ?

La rédaction technique implique généralement de décomposer des connaissances techniques complexes en mots simples, rendant plus facile pour un public non technique de comprendre les concepts techniques. Le but de la rédaction technique est de s'assurer que les utilisateurs peuvent utiliser efficacement une technologie, ce qui améliore finalement la satisfaction des utilisateurs.

En tant que rédacteur technique, vous pouvez écrire sur une large gamme de sujets et écrire pour différents objectifs et publics. Certains des types d'écriture que vous pourriez faire incluent :

• Manuels utilisateur
• Documentation
• Guides détaillés
• Articles de blog
• Livres blancs
• Procédures opérationnelles standard (SOPs)

et ainsi de suite.

La précision, la cohérence, la clarté et la concision sont certains des aspects cruciaux de la rédaction technique.

Quelles sont les responsabilités d'un rédacteur technique ?

La rédaction technique nécessite des recherches approfondies, ce qui peut rendre le processus d'écriture plus long. Les rédacteurs techniques restent en contact avec des experts en la matière (SMEs) pour comprendre les détails techniques des produits/services des clients.

Après avoir recueilli beaucoup d'informations grâce à des entretiens avec des experts et des recherches, les rédacteurs techniques compilent les informations pertinentes dans leur écriture.

Après avoir acquis une certaine expérience, les rédacteurs techniques peuvent également devoir éditer et corriger les écrits des autres. La relecture et l'édition nécessitent de la patience, de l'attention aux détails et de l'empathie.

Comment devenir rédacteur technique

Partagez vos connaissances

Commencez à écrire des tutoriels, des guides pratiques et partagez votre expérience avec la technologie sur une plateforme de publication ouverte comme Medium, Hashnode ou HackerNoon. Ces sites de blog sont faciles à gérer pour les débutants car ils sont gratuits et certaines de leurs publications ont une grande base d'audience.

Si vous n'êtes pas sûr de la façon d'écrire des articles techniques, commencez par en lire beaucoup. Cela commencerà à vous donner une idée de la manière dont les rédacteurs techniques partagent leurs informations de manière accessible, comment ils structurent leurs articles, quels sujets ils abordent, et ainsi de suite.

Voici quelques idées d'articles de blog adaptés aux débutants :

• Comment faire X dans/avec Y (Exemple : Comment créer un site portfolio dans WordPress)
• X façons de faire Y (Exemple : 3 façons d'éviter le surapprentissage dans les modèles de machine learning)
• Ce que j'ai appris en 10 jours de travail avec X (Exemple : Ce que j'ai appris en 10 jours de travail dans VSCode)
• Un guide sur X : Tout ce que vous devez savoir (Exemple : Un guide sur les constructeurs de sites web IA : Tout ce que vous devez savoir)

Vous pouvez également lire divers guides de rédaction technique de publications. Ceux-ci contiennent de nombreux conseils utiles et informations sur la façon d'écrire de bons tutoriels techniques. Digital Ocean en a un assez connu, et freeCodeCamp a le leur également.

Construisez un portfolio

Une fois que vous avez quelques exemples d'écriture, vous pouvez aider à construire votre crédibilité en créant un portfolio en ligne qui contient tous vos exemples d'écriture. C'est quelque chose que vous pouvez partager avec des employeurs potentiels ou des responsables de projet.

Vous pouvez le partager sur les plateformes de médias sociaux, l'afficher dans la section mise en avant de LinkedIn et l'envoyer à des clients potentiels.

Vous pouvez également essayer d'écrire pour des publications. Les publications bien connues ont souvent un grand nombre de followers et elles partagent le contenu des contributeurs sur leurs plateformes de médias sociaux. Cela peut aider à construire votre marque personnelle en tant que rédacteur technique, à développer votre réseau et à vous motiver à écrire plus de bonnes choses.

Certaines publications qui acceptent les contributions de nouveaux rédacteurs sont :

• freeCodeCamp : freeCodeCamp s'attend à ce que vous ayez au moins trois exemples d'écriture lorsque vous soumettez une demande de contributeur. Le processus de demande est un peu plus rigoureux que certains, et ils n'acceptent pas toutes les demandes pour diverses raisons. Mais si vous n'avez pas de nouvelles d'eux et que vous n'êtes pas accepté la première fois, ne abandonnez pas. Vous pouvez continuer à améliorer votre écriture et réessayer plus tard – ou essayer d'autres publications. Vous pouvez trouver les directives pour les contributeurs de fCC ici.
• Towards Data Science : Towards Data Science accepte les articles tournant autour de la science des données et du machine learning. Ils s'attendent à ce que vous soumettiez des articles bien structurés, complets et à jour. Lisez les directives pour les contributeurs de TDS ici.
• Level Up Coding : Level Up Coding est une publication en ligne axée sur le partage de connaissances techniques pour aider les ingénieurs logiciels à apprendre et à grandir. Ils ont un public de développeurs, de designers et de scientifiques des données, ils s'attendent donc à un contenu utile pour eux. Voici les directives de contribution pour Level Up Coding.

Bien que toutes les publications aient des directives de contribution en place pour aider les contributeurs à écrire des exemples pertinents, voici quelques conseils pour réussir votre pitch :

1. Familiarisez-vous : Lisez au moins 3 à 5 articles les mieux notés dans la publication à laquelle vous souhaitez contribuer. Faites attention au ton de la voix et au niveau de détail partagé pour comprendre leurs préférences.
2. Créez un plan : Un plan est une structure pour votre contenu qui vous maintient sur la bonne voie pendant l'écriture. Vous pouvez créer un bon plan en utilisant le contenu le mieux noté, des outils d'IA et votre expertise.
3. Rédigez un brouillon : Créez un brouillon basé sur votre plan et laissez-le reposer pendant au moins deux jours. Cet intervalle vous aide à repérer les erreurs dans votre brouillon que vous pourriez négliger pendant ou immédiatement après l'écriture.
4. Soumettez votre brouillon : Enfin, envoyez votre brouillon pour révision à la publication. Ils pourraient éditer votre brouillon ou vous demander de faire quelques changements avant de le publier. Certaines publications utilisent également des détecteurs de contenu IA, donc si votre publication le fait, assurez-vous de vérifier votre contenu en utilisant le même détecteur IA.

Partagez votre travail

Pendant que vous construisez votre portfolio d'articles techniques, vous pouvez les partager sur LinkedIn (et d'autres sites de médias sociaux comme Twitter) pour faire savoir au monde vos nouvelles compétences – et que vous écrivez sur des sujets techniques intéressants.

Vous pouvez également inclure un lien vers votre profil LinkedIn dans les articles que vous écrivez, si la publication le permet, pour aider les gens à vous trouver. Vous serez surpris de voir combien de personnes admirent votre travail, et cela vous motivera à continuer. Vous pourriez également recevoir des projets rémunérés et des opportunités d'emploi dans vos messages privés.

Améliorez vos compétences en rédaction de documentation

Une excellente façon de pratiquer votre rédaction technique (et d'aider les autres en cours de route) est de contribuer à des problèmes de documentation sur des projets open-source GitHub. Cela élargira votre ensemble de compétences et vous donnera de l'expérience dans la rédaction de documentation et vous aidera à vous familiariser avec les directives pour les contributeurs.

La rédaction de documentation est plus axée sur le produit et, contrairement aux articles de blog, est généralement concise. Elle suit une structure prédéfinie, et le format du contenu à travers les pages est cohérent. L'accessibilité, la cohérence et la clarté sont les meilleures pratiques générales de la rédaction de documentation.

Faites attention aux suggestions de l'éditeur pour développer une meilleure compréhension. Il y a généralement deux types de suggestions d'éditeur : objectives et subjectives. Les suggestions objectives concernent les directives générales d'écriture telles que la transition et la clarté, tandis que les suggestions subjectives sont axées sur le ton et les préférences de l'entreprise.

Les suggestions objectives vous aident à améliorer vos compétences en écriture et les suggestions subjectives vous guident pour vous aligner avec la voix de l'entreprise.

Trouvez des projets rémunérés

Une fois que vous êtes à l'aise avec l'écriture de contenu technique et la recherche de contenu, commencez à chercher du travail rémunéré. Postulez à des emplois de niveau débutant ou cherchez des projets freelance sur des tableaux d'offres d'emploi et dans votre cercle. Faire le vrai travail vous aidera vraiment à faire avancer votre parcours de rédaction technique.

Bien que les plateformes freelance soient devenues compétitives, vous pouvez toujours y trouver des projets rémunérés. Le personal branding fait des merveilles pour obtenir des opportunités rémunérées. Gardez vos profils GitHub et LinkedIn à jour, et partagez vos réalisations là-bas pour attirer des clients potentiels et vous démarquer de la foule.

Comment apprendre les compétences pour la rédaction technique

Vous pouvez trouver beaucoup de cours d'écriture de qualité, mais trouver le bon cours peut être un défi. J'ai suivi quelques cours d'écriture et j'aimerais vous aider en partageant les conseils et les cours qui valent votre temps :

1. Le cours Secret Sauce of Great Writing by Shani Raja est un cours parfait pour les débutants. Il couvre les aspects fondamentaux de la bonne écriture avec des exercices pratiques et de nombreux exemples.
2. DevRel Uni est un programme en ligne basé sur des cohortes pour les personnes cherchant à passer aux relations avec les développeurs. Ils ont une classe séparée sur la rédaction de documentation où des experts partagent les secrets d'une bonne documentation.
3. Chaque fois que vous obtenez votre premier projet externe, faites attention aux suggestions de l'éditeur. Si c'est un article de contributeur et qu'ils n'offrent pas un processus d'édition en tête-à-tête, comparez votre copie soumise avec l'article publié. Prenez note des changements qu'ils ont apportés. Les suggestions de l'éditeur sont précieuses pour améliorer votre écriture et si vous les prenez au sérieux, vous verrez bientôt des améliorations dans votre écriture.

Conclusion

Bien que le changement de carrière puisse être excitant, passer du développement à la rédaction technique n'est pas trop décourageant. Vous devez simplement gérer votre anxiété face au changement de carrière, construire un portfolio et commencer à cultiver votre marque personnelle pour une transition réussie.

Vous avez encore des questions ? N'hésitez pas à me contacter sur LinkedIn.