Article original : How to Start a Career in Technical Writing by Contributing to Open Source

L'une des questions les plus courantes qu'on me pose est : "Comment puis-je commencer en rédaction technique ?" Et honnêtement, j'adore cette question car cela signifie que de plus en plus de personnes commencent à voir l'écriture comme une manière valable et précieuse d'entrer dans l'industrie technologique.

Commencez par l'open source. C'est ce que je leur dis généralement.

Cela peut sembler intimidant au début, mais l'open source est l'une des manières les plus accessibles et accueillantes d'apprendre en faisant. Vous n'avez pas besoin d'être un expert. Vous n'avez pas besoin de savoir coder de manière extensive. Vous devez simplement être prêt à écrire, rechercher, poser des questions et contribuer.

Dans cet article, je vais partager ce que j'ai appris de ma propre expérience en commençant une carrière en rédaction technique grâce à l'open source.

Table des matières

Idées reçues sur la rédaction technique

Avant de commencer, dissipons quelques idées reçues sur la rédaction technique.

"Vous n'avez pas besoin de savoir coder."

Ce n'est tout simplement pas vrai. Bien que vous n'ayez pas besoin d'être ingénieur logiciel pour écrire une excellente documentation, comprendre les concepts techniques de base est important, surtout si vous voulez communiquer efficacement avec les développeurs ou documenter des outils complexes.

Cela dit, de nombreux rédacteurs techniques, moi y compris, apprennent sur le tas. Vous pouvez commencer avec ce que vous savez et développer vos compétences à partir de là. La compétence clé n'est pas nécessairement le codage – c'est la capacité à expliquer les choses clairement et à poser les bonnes questions.

"Il s'agit simplement de rédiger des choses clairement."

C'est plus que cela. La rédaction technique consiste à comprendre comment quelque chose fonctionne, à déterminer ce que les utilisateurs doivent savoir, puis à organiser ces informations de manière utile et accessible.

Cela implique des recherches, poser des questions, tester des choses et souvent travailler en étroite collaboration avec des développeurs ou des équipes produit. La véritable compétence réside dans la transformation de la complexité en clarté – non seulement dans l'écriture, mais aussi dans la pensée claire et la structuration des informations de manière à aider les gens à réussir.

"Vous avez besoin d'un diplôme ou d'une certification en rédaction technique."

C'est également faux. Bien qu'un cours ou une certification puisse vous aider à gagner en confiance, ils ne sont pas obligatoires. De nombreuses personnes commencent en contribuant à la documentation open source, en construisant un portfolio et en apprenant sur le tas. Votre travail parle de lui-même, et l'open source vous donne l'opportunité de construire ce corpus de travail publiquement.

"La rédaction technique est ennuyeuse."

Pas du tout. Certes, vous n'écrivez pas de fiction, mais vous résolvez des problèmes, aidez les gens et construisez des ponts entre les développeurs et les utilisateurs. Chaque phrase que vous écrivez peut aider quelqu'un à comprendre quelque chose plus rapidement ou à se sentir moins frustré. C'est un impact réel.

Cela étant dit, continuons.

Qui est un rédacteur technique ?

Les rédacteurs techniques sont le pont entre les ingénieurs et tout le monde. Nous rendons les choses complexes plus simples à comprendre, et notre travail apparaît dans la documentation, les tutoriels, les références API, les guides de prise en main, et plus encore.

En tant que rédacteur technique, la manière dont vous expliquez les choses peut affecter la façon dont les gens utilisent un produit, comment les développeurs commencent, et comment les communautés évoluent. Une bonne documentation est essentielle pour l'adoption, et les entreprises recherchent des rédacteurs capables d'expliquer des informations techniques avec la bonne empathie et structure.

Un bon rédacteur technique fait plus que simplement bien écrire. Il écoute, recherche et pense de manière critique. Certaines des compétences clés dont vous aurez besoin en tant que rédacteur technique incluent :

  • Clarté et structure dans l'écriture : Être capable d'expliquer les choses simplement et logiquement.

  • Curiosité et volonté d'apprendre : Poser des questions, explorer des outils et approfondir des concepts inconnus.

  • Empathie pour l'utilisateur : Comprendre ce dont les gens ont besoin et comment ils pensent.

  • Compréhension technique de base : Vous n'avez pas besoin d'être programmeur, mais être à l'aise avec des outils, des processus ou la lecture de code de base vous aide à mieux expliquer les concepts techniques.

Qu'est-ce que l'open source ?

Il existe de nombreux projets open source qui alimentent des outils et des technologies que vous pourriez utiliser tous les jours, et bien d'autres qui alimentent Internet. Des projets comme Linux, Python, Git, Wikipedia, Firefox, WordPress et freeCodeCamp sont des projets open source.

L'open source fait référence à la pratique de rendre les rouages internes d'un projet – qu'il s'agisse de logiciels, de matériel, de contenu ou de recherche – ouvertement disponibles pour que chacun puisse les consulter, les utiliser, les modifier et les améliorer.

Fondamentalement, l'open source repose sur plusieurs principes puissants :

  • Transparence : Chacun peut inspecter le projet, comprendre son fonctionnement, en apprendre et y contribuer. Rien n'est caché.

  • Collaboration : Des personnes du monde entier peuvent contribuer, suggérer des améliorations et résoudre des problèmes ensemble.

  • Innovation pilotée par la communauté : Le progrès se fait par l'effort partagé. Les meilleures idées émergent souvent lorsque des contributeurs divers se réunissent.

L'open source consiste à créer des choses ensemble, de manière ouverte.

Pourquoi construire votre carrière en rédaction technique avec l'open source

Pour commencer en rédaction technique, vous avez besoin de trois choses : un outil pour documenter, un public pour qui écrire et une plateforme pour partager votre travail. L'open source vous donne accès à tout cela et plus encore.

Parlons de pourquoi contribuer à l'open source est une manière puissante de commencer et de développer votre carrière en rédaction technique.

Tout d'abord, cela peut vous donner une excellente expérience réelle. Vous obtenez une pratique concrète avec la documentation pour des outils et produits réels utilisés par de vrais développeurs et utilisateurs – pas seulement des projets hypothétiques ou d'entraînement.

Ensuite, contribuer à l'open source peut vous aider à développer vos compétences. De la rédaction de guides techniques à l'amélioration des flux de prise en main, vous renforcerez à la fois votre écriture et votre compréhension technique.

Cela vous aide également à construire votre portfolio, votre visibilité et votre crédibilité. Vos contributions deviennent un moyen tangible de montrer vos compétences en écriture et en travail sur différents types de projets de documentation.

Votre travail public, vu par les mainteneurs, les contributeurs et même les recruteurs, peut également vous aider à construire une réputation dans le domaine.

Contribuer vous aide également à développer des compétences en collaboration multifonctionnelle. Vous travaillerez souvent aux côtés de développeurs, de designers et d'autres membres de l'équipe produit, comme dans un vrai travail.

En tant que rédacteur technique, votre implication vous aide également à comprendre comment ils pensent et développent des logiciels, ce qui améliore votre écriture pour les publics techniques.

En plus de pratiquer ce que vous savez déjà, il y aura de nombreuses opportunités pour vous d'apprendre de nouvelles compétences. Si vous souhaitez apprendre de nouvelles choses tout en étant pratique, l'open source est un excellent endroit pour cela. En travaillant sur des projets open source, vous pouvez acquérir une expérience pratique avec de nouveaux outils, des plateformes de documentation et même des langages de programmation.

Vous rencontrez également de nombreuses personnes prêtes à vous mentoriser, à examiner votre travail et à offrir des commentaires, afin que vous ne grandissiez pas en isolation.

Et enfin, vous avez un impact réel. Une bonne documentation donne du pouvoir aux personnes pour qui vous écrivez. Votre écriture pourrait être la raison pour laquelle quelqu'un rejoint un projet ou commence à utiliser un nouvel outil.

Vous n'écrivez pas seulement des docs. Vous rendez la technologie plus accessible, les communautés plus accueillantes et l'apprentissage plus équitable.

Votre rôle dans l'open source en tant que rédacteur technique

Dans l'open source, les rédacteurs techniques jouent un rôle crucial en rendant les projets utilisables, accessibles et évolutifs.

En tant que rédacteur technique, vos contributions peuvent inclure :

  • Rédiger et améliorer la documentation : Des guides d'installation aux références API, vous aidez les utilisateurs à commencer et à rester débloqués.

  • Créer des ressources de prise en main : Vous facilitez l'arrivée de nouveaux contributeurs en documentant la structure du projet, les flux de travail et les meilleures pratiques.

  • Clarifier les concepts techniques : Vous transformez des idées complexes en un langage clair et accessible pour les utilisateurs de différents niveaux de compétence.

  • Organiser le contenu : Vous aidez à structurer les docs de manière logique afin que les utilisateurs puissent trouver ce dont ils ont besoin sans frustration.

  • Repérer les lacunes : Vous posez des questions importantes comme : "Qu'est-ce qui manque ? Qu'est-ce qui n'est pas clair ? Qu'aurais-je besoin de savoir en tant qu'utilisateur pour la première fois ?"

Au-delà de l'écriture, vous devenez un défenseur de la perspective de l'utilisateur, identifiant les points de friction, promouvant la clarté et façonnant l'expérience utilisateur globale d'un projet.

Votre rôle va au-delà de la simple documentation – il s'agira également de combler le fossé entre les créateurs et les utilisateurs et d'aider les communautés open source à grandir en rendant leur travail plus accessible à tous.

Compétences techniques dont vous aurez besoin pour commencer

Vous n'avez pas besoin d'être développeur pour contribuer en tant que rédacteur technique dans l'open source, mais avoir quelques compétences de base rendra votre parcours plus fluide et plus impactant.

Les compétences techniques de base sur lesquelles vous concentrer incluent :

Git & GitHub/GitLab

Le contrôle de version est essentiel dans l'open source. Apprenez à cloner des dépôts, créer des branches, faire des commits et soumettre des pull requests (PR). Ce sont les flux de travail de base pour contribuer à des projets et collaborer avec d'autres.

Voici un manuel qui vous enseignera toutes les bases de Git dont vous aurez besoin dans votre routine quotidienne.

Markdown

Le Markdown est le format le plus courant pour écrire de la documentation open source. Il est simple et léger, utilisé pour ajouter une structure comme des titres, des puces, des blocs de code, des liens et des images à la documentation.

Voici une feuille de triche qui vous enseignera les bases du Markdown – elle est conçue pour les rédacteurs techniques.

Ligne de commande de base

Savoir naviguer dans les dossiers, exécuter des commandes simples et installer des outils depuis le terminal peut vous aider à tester des logiciels et à comprendre le contexte dont vous parlez.

Vous pouvez apprendre les bases de la ligne de commande et des scripts bash dans ce tutoriel détaillé.

Et voici un manuel qui couvre certaines des commandes Linux les plus couramment utilisées que vous devrez connaître.

Éditeurs de texte

Des outils comme VS Code, Cursor ou même les éditeurs en ligne sur GitHub sont couramment utilisés pour écrire et éditer de la documentation. Savoir comment travailler avec eux rendra vos contributions plus faciles.

Vous pouvez apprendre à utiliser VS Code, l'un des éditeurs les plus populaires parmi les développeurs, dans ce cours accéléré.

Lecture de code

Vous n'avez pas besoin d'être programmeur, mais être capable de parcourir du code et de comprendre les structures de fichiers ou les noms de fonctions peut aider lors de la documentation de quelque chose.

Vous n'avez pas besoin de maîtriser tout avant de commencer. Ce sont des compétences que vous devrez développer en cours de route. La chose la plus importante est d'être curieux, de poser des questions et de continuer à apprendre tout en contribuant.

Comment construire un portfolio de rédaction technique grâce à l'open source

L'open source est l'une des manières les plus efficaces de construire un portfolio solide et public et de lancer votre carrière en tant que rédacteur technique. Voici un guide étape par étape pour vous aider à commencer à contribuer à l'open source en tant que rédacteur technique :

Créez un compte GitHub (et optionnellement GitLab)

La plupart des projets open source sont hébergés sur GitHub, c'est donc votre porte d'entrée pour les trouver et y contribuer. Assurez-vous que votre profil est complet et professionnel – considérez-le comme votre CV public.

Voici un aperçu de ce à quoi peut ressembler un bon profil GitHub (c'est le mien 😁), avec une bio claire, un travail actuel, des centres d'intérêt et des moyens de se connecter. Vous n'avez pas besoin de trop y réfléchir – assurez-vous simplement qu'il reflète qui vous êtes et sur quoi vous travaillez.

Mon profil GitHub

Explorez les opportunités axées sur la documentation

Recherchez des dépôts étiquetés avec des labels comme documentation, good-first-issue ou help wanted. Ceux-ci signalent généralement que certaines tâches (problèmes) sont accessibles aux nouveaux contributeurs et souvent liées à l'amélioration ou à la création de documentation.

Quelques exemples de projets open source connus pour être accueillants pour les contributeurs de documentation incluent Mautic, GitHub, Mozilla, Layer5, Kubernetes, etc.

Vous pouvez également parcourir des communautés comme Hashnode, Dev.to, ou le subreddit r/opensource pour trouver des projets recherchant un soutien en rédaction.

Commencez par des contributions simples

Commencez en douceur en vous attaquant à des tâches petites mais précieuses comme la correction de fautes de frappe ou d'erreurs de grammaire, l'amélioration de la clarté et de la structure, et l'amélioration de la mise en forme ou de la cohérence.

Ces types de modifications vous aident à apprendre le flux de travail de contribution et à gagner en confiance. À mesure que vous devenez plus à l'aise, prenez en charge des tâches plus importantes, comme la rédaction de tutoriels, de guides de prise en main ou la réorganisation de systèmes de documentation.

Engagez-vous avec les mainteneurs du projet

Avant d'apporter des modifications, présentez-vous en ouvrant un problème ou en commentant un problème existant. Demandez si vous pouvez travailler sur une amélioration spécifique et clarifiez les attentes en matière de style, de ton ou de structure.

Une bonne communication montre du respect pour le projet et augmente les chances que votre contribution soit acceptée.

Documentez votre travail au fur et à mesure

Pour chaque contribution que vous faites, gardez-en une trace. Créez un portfolio de documentation personnel avec des liens vers des pull requests ou des contributions fusionnées, des captures d'écran ou des comparaisons avant/après, et des explications de ce que vous avez amélioré et pourquoi.

Ce portfolio sert de preuve convaincante de vos compétences et de votre impact, ce qui peut être bénéfique pour les candidatures à des emplois, le travail freelance ou la reconnaissance communautaire.

Après avoir contribué, que faire ensuite ?

Une fois que vous avez commencé à faire des contributions, vous n'êtes plus "aspirant" – vous faites déjà le travail. C'est quelque chose à célébrer. Mais ce n'est aussi qu'un début. Voici comment maintenir l'élan et transformer vos contributions en une base pour la croissance :

Réfléchissez à ce que vous avez appris

Après mes premières contributions open source (correction de la mise en forme et clarification des guides de contribution), j'ai réalisé à quel point j'ai appris simplement en naviguant dans le dépôt, en lisant les problèmes et en comprenant comment soumettre une PR.

Je n'améliorais pas seulement les docs. J'apprenais Git et je comprenais les normes communautaires. Posez-vous la question : Qu'est-ce que vous avez aimé ? Qu'est-ce qui était difficile ? Qu'est-ce que vous feriez différemment la prochaine fois ?

Demandez des commentaires

N'ayez pas peur de contacter les mainteneurs ou les autres contributeurs. Des commentaires réfléchis peuvent affiner votre écriture, améliorer vos compétences en collaboration et vous aider à grandir plus rapidement.

Je laissais souvent des commentaires comme : "Hey ! J'ai soumis une petite modification pour améliorer la clarté dans cette section. J'adorerais avoir votre avis sur le ton et la structure pour voir s'ils correspondent à votre guide de style existant."

Chaque fois que je l'ai fait, j'ai obtenu soit une confirmation, soit des conseils utiles, et les deux m'ont aidé à grandir plus vite.

Restez impliqué dans la communauté

Contribuer une fois est merveilleux. Mais rester actif, participer aux discussions, rejoindre des réunions ou aider d'autres nouveaux arrivants approfondit votre compréhension et renforce votre place dans le projet.

Contribuez à nouveau (et encore)

Recherchez d'autres domaines dans le même projet ou explorez-en de nouveaux. À mesure que vous gagnez en expérience, essayez de vous attaquer à des tâches de documentation plus complexes ou d'aider à façonner la stratégie de documentation.

Partagez votre parcours

Documentez votre expérience à travers des articles de blog, des tweets ou des vidéos. Le partage met en avant votre travail et inspire les autres à contribuer.

J'ai écrit des articles de blog et des fils Twitter reflétant mon processus d'apprentissage, non seulement pour célébrer mais aussi pour documenter ce que j'ai fait et aider les autres qui sont quelques étapes derrière moi. Presque chaque fois que j'ai publié quelque chose sur l'apprentissage de l'open source, quelqu'un m'a contacté pour dire que cela l'avait aidé ou pour poser des questions.

Vous pourriez être la motivation dont quelqu'un a besoin pour commencer à contribuer aussi.

Rejoignez des communautés d'écriture

Connectez-vous avec d'autres rédacteurs à travers des groupes comme Write the Docs, la communauté Hackmamba, ou même des rencontres locales d'écriture. Ces communautés offrent du soutien, des ressources et de nouvelles opportunités.

Transformez cela en une carrière

Utilisez vos contributions comme portfolio pour postuler à des stages, des bourses ou des rôles juniors en rédaction technique. Proposez vos écrits à des blogs ou publications axés sur les développeurs comme freeCodeCamp. Et commencez le travail freelance pour des startups ou des organisations open source.

La rédaction technique offre tant de chemins – des rôles à temps plein, du freelance, de l'éducation des développeurs, de la stratégie de contenu, de l'ingénierie de documentation – et le travail que vous faites dans l'open source peut mener à n'importe lequel d'entre eux.

Continuez à apprendre

La rédaction technique est une compétence que vous pouvez continuer à affiner à travers des cours, des révisions par les pairs, du mentorat et de la pratique pratique. Vous pouvez explorer de nouveaux outils ou apprendre un peu de code ; faites ce qui vous aide à grandir.

Conclusion

Votre première contribution prouve que vous pouvez écrire pour des outils réels, collaborer dans des espaces techniques et ajouter de la valeur aux communautés. Ce qui vient ensuite dépend de vous, mais vous avez déjà franchi l'étape la plus importante : vous avez commencé.

Vous avez des questions ou souhaitez partager votre parcours ?

Je serais ravi d'avoir de vos nouvelles. N'hésitez pas à me contacter ou à me rejoindre sur LinkedIn.