1,180 lectures

Développeurs de logiciels, pourquoi n'avez-vous pas encore commencé la rédaction technique ?

par Ankur Tyagi12m2023/10/20

Trop long; Pour lire

Enseigner et écrire sur n’importe quoi est le meilleur moyen d’en apprendre davantage, et c’est un fruit facile à saisir pour commencer un nouveau style de vie.

featured image - Développeurs de logiciels, pourquoi n'avez-vous pas encore commencé la rédaction technique ?

‘a programmer typing on his keyboard’ Image created by HackerNoon AI Image Generator

Un blog est un élément utile pour de nombreuses raisons, non seulement pour vous mais aussi pour d'autres développeurs de logiciels technologiques.

La rédaction technique aide un développeur de logiciels à partager ses connaissances/expériences techniques avec d'autres développeurs de logiciels en génie logiciel.

La rédaction technique est une discipline d'écriture qui consiste à communiquer des informations complexes à ceux qui en ont besoin pour effectuer une certaine tâche ou atteindre un certain objectif. Pour cette raison, la rédaction technique est souvent définie comme « simplifier le complexe ».

Cela améliore également votre compréhension du sujet sur lequel vous écrivez et montre clairement votre expertise technique.

La chose la plus unique à propos de la rédaction technique est non seulement que vous avez été en mesure de générer d'excellentes opportunités futures (un emploi à distance dans le domaine de la technologie, un contrat de rédaction indépendant ou une opportunité de publication d'invité sur le site Web d'une grande entreprise technologique, etc.), mais cela peut vous aider à construire une présence en ligne qui vous aide éventuellement dans votre carrière de développeur de logiciels.

Parfois, je reviens en arrière et lis mes articles de blog lorsque je recherche des informations sur un sujet spécifique.

Si vous avez fait quelque chose d'intéressant dans votre carrière d'ingénieur logiciel mais que vous le gardez pour vous, vous passez à côté d'une grande opportunité génératrice.
Commencez à écrire et c'est un moyen efficace de promouvoir vos idées sur Internet.
« Écrivez le blog que vous souhaiteriez trouver quand… https://t.co/PcXR0fL9QF
– Ankur💻🎧💪 (@TheAnkurTyagi) 3 octobre 2023

De plus, si vous aimez aider les autres à apprendre, si vous aimez faire partie de projets open source et montrer aux autres comment y participer, ou si vous trouvez de la satisfaction à expliquer des idées complexes de manière facile à comprendre à travers votre écriture, alors la rédaction technique est un excellent choix pour toi.

Dans cet article, mon objectif est d'expliquer comment la programmation et l'écriture peuvent fusionner pour élever nos compétences de développeur. Oui, écrire ! Je pense sincèrement que nous possédons tous un certain niveau de capacité à écrire. Je suis ici pour vous fournir des astuces de rédaction, des conseils et des exemples pour vous aider à devenir un développeur et un communicateur plus compétent.

Qu'est-ce que la rédaction technique

La rédaction technique consiste à donner des instructions claires et détaillées pour aider les utilisateurs, les collègues développeurs ou les gestionnaires à les aider à comprendre un produit technique, une compétence ou une idée technique.

Un rédacteur technique est quelqu'un qui crée ces didacticiels et cette documentation technique.

La rédaction technique pourrait être :

Comment utiliser les guides d'utilisation ou l'intégration entre deux SaaS techniques
Articles d'assistance en ligne
Rapports techniques qui présentent des informations sur un sujet spécifique, souvent après avoir mené des recherches ou des expériences. Ils sont courants dans les domaines scientifiques et techniques.
Propositions techniques , ces documents décrivent un plan, une idée ou un projet de manière claire et convaincante. Ils sont utilisés pour rechercher l’approbation, le financement ou la collaboration.
Métamatériaux internes pour les programmeurs et documentation API pour les développeurs.

Essentiellement, un rédacteur technique transmet les détails techniques d’une manière qui permet au lecteur d’appliquer efficacement ces informations dans un but spécifique.

Si vous débutez dans la rédaction technique et essayez d'écrire sur le développement/la programmation de logiciels ou sur ce que vous avez appris en technologie, mais que vous n'avez pas encore écrit votre premier blog, vous trouverez la plus grande valeur dans les deux premières sections de cet article de blog dans lequel je explique comment démarrer en tant que rédacteur technique ou blogueur et comment faire évoluer votre blog.

Le reste du blog vous sera utile pour combler les lacunes en matière de connaissances dont vous aurez besoin pour réussir en tant que développeur de logiciels, prospérer sur le lieu de travail et faire progresser votre carrière.

« Si vous avez un rêve, vous pouvez passer votre vie à l’étudier, à le planifier et à vous y préparer. Ce que vous devriez faire, c’est commencer.
—Drew Houston

L'écriture est partout ?

Les deux principales ressources en ligne que les gens utilisent pour apprendre à coder sont la documentation technique et Stack Overflow, les blogs complétant les trois premières.

Le trio gagnant pour permettre aux gens de se former eux-mêmes à la technologie comprend une documentation claire, une communauté dynamique proposant des solutions et des publications fréquentes.

Les développeurs apprécient un large éventail de sources supplémentaires, notamment des vidéos pratiques, des didacticiels écrits, des livres et des forums. Ils rassemblent les sources et les formats qui conviennent le mieux à leur style d'apprentissage.

Être capable d'exprimer clairement ses idées au sein de l'équipe et en ligne est une compétence précieuse, car de nombreux développeurs trouvent cela difficile. Pensez simplement à la quantité d'écriture que vous faites chaque jour qui n'implique pas l'écriture de code. Cette compétence est un super pouvoir.

Vous vous engagez dans diverses formes d'écriture telles que les discussions Slack, les e-mails, les documents de développement internes, les brouillons RCA, les fichiers Lisez-moi, les commentaires de code, les messages de validation Git, les demandes d'extraction, les commentaires de révision de code, les commentaires annuels sur les performances, les notes de réunion, etc.

La maîtrise de l’écriture est cruciale pour les développeurs de logiciels. Des compétences rédactionnelles insuffisantes peuvent entraver leur progression professionnelle au-delà d’un certain point. De nombreux ingénieurs se rendent compte plus tard dans leur carrière que « les compétences générales sont tout aussi importantes que le code ».

Jeunes : votre carrière en génie logiciel s'améliorera considérablement et vous obtiendrez de meilleures opportunités futures dans le domaine de la technologie si vous commencez à écrire 30 minutes chaque jour et à publier 2 à 3 blogs en ligne chaque mois, mais très peu de développeurs sont réellement capables de le faire au cours de la période. long terme. https://t.co/damIJ5gXys
– Ankur💻🎧💪 (@TheAnkurTyagi) 4 octobre 2023

Pourquoi l'écriture est cruciale pour les développeurs

JavaScript, TypeScript, PHP, Go, Java : il existe de nombreux langages de programmation différents et vous en maîtrisez peut-être même plusieurs.

Alors que nous nous efforçons de produire du code de meilleure qualité dans nos carrières technologiques, la capacité d’écrire et de communiquer efficacement dans un langage courant devient une compétence cruciale, qui peut être sous-estimée dans le domaine du génie logiciel.

Le génie logiciel ne concerne pas seulement le code. Il s'agit de personnes + de code.
Comment devenir un meilleur écrivain en tant qu'ingénieur logiciel

La manière dont les ingénieurs expriment leurs réflexions sur le code peut être tout aussi cruciale que le code lui-même. Quelle que soit votre position sur cette question, nous pouvons unanimement reconnaître que nos paroles ont le pouvoir d’améliorer ou d’entraver l’efficacité du code.

L’écriture peut vous aider à augmenter votre surface de chance.

L = D * T, où L représente la chance, D fait et T raconte.
– Jason C. Roberts

6 avantages majeurs de la rédaction technique

Cela vous aide à comprendre les concepts à un niveau plus profond.

Vous devez rechercher les concepts que vous expliquez, ce qui vous expose à différentes idées, applications et pièges.
Les concepts collent mieux dans votre cerveau lorsque vous les expliquez aux autres.
En structurant et en présentant des informations pour les autres, vous découvrez souvent des lacunes dans vos connaissances. En conséquence, cela vous aide également à progresser plus rapidement dans votre carrière de développeur.
Les rédacteurs techniques apprennent tout au long de leur vie, car à chaque nouveau blog technique que vous recherchez et écrivez, vous deviendrez un expert sur ce sujet.
L'écriture favorise également une compréhension plus profonde de l'empathie des utilisateurs. Cela vous incite à vous concentrer davantage sur les points de vue et les sentiments des lecteurs ou des utilisateurs du produit, plutôt que de vous fier uniquement à votre point de vue.
Voici quelques avantages supplémentaires :

De plus, vous pouvez générer des revenus en tant que rédacteur technique en contribuant à diverses organisations. Découvrez ces superbes entreprises qui paient des écrivains techniques .

À l’université, j’ai étudié en donnant des cours particuliers dans une auberge

Expliquer quelque chose, ou même faire semblant de le faire, vous oblige à organiser vos connaissances de manière cohérente, en exposant les lacunes de vos connaissances et en renforçant les parties que vous connaissez.

La meilleure façon d’apprendre est d’enseigner et l’écriture est un atout majeur pour tout développeur.

Au lieu de simplement y prêter attention, les gens et les entreprises vous le rendent bien. Lorsque vous rédigez un article de blog technique, vous recevez un retour instantané. Votre rédaction technique aide également à faire passer le message, ouvrant les portes à des opportunités encore plus intrigantes.

Il y a aussi une carrière lucrative à faire dans la rédaction technique si vous l'aimez et presque tout ce que j'écris sur mon blog ces jours-ci sont des concepts que j'essaie de mieux comprendre. Si je ne peux pas l’expliquer par écrit, c’est que je ne le comprends pas correctement.

Quels sont les exemples de rédaction technique ?

En tant que rédacteur technique, votre rôle consiste à traduire des informations techniques complexes dans un langage accessible et convivial. La rédaction technique englobe diverses formes, notamment la création de didacticiels étape par étape et de guides complets.

L'objectif principal est de faciliter la compréhension de tous les aspects techniques d'un produit ou d'un service, que ce soit parmi les membres de l'équipe interne ou les utilisateurs finaux.

Dans cet esprit, les exemples de rédaction technique suivants devraient vous permettre de bien comprendre.

SuperTokens Review – une alternative open source à Auth0, Firebase Auth et AWS Cognito.

Il s'agit d'un exemple très simple d'examen des supertokens et de la raison pour laquelle les « supertokens » constituent une bonne authentification des utilisateurs.

Comment utiliser Medusa pour créer une boutique de commerce électronique Next.js

C'est un très bon exemple de la façon dont vous pouvez créer un didacticiel tout en créant une application. Dans ce blog, j'ai partagé un guide étape par étape pour créer une boutique de commerce électronique par Medusa, qui est une alternative open source à Shopify.

Comment déployer des LLM avec MindsDB et OpenAI

Dans ce guide, j'ai expliqué comment déployer des LLM avec MindDB et OpenAI

Comment migrer votre base de données de Supabase vers HarperDB

Un tutoriel complet sur la façon dont vous pouvez migrer votre base de données de Supabase vers HarperDB

5- Documentation produit

La documentation du produit comprend des instructions sur l'utilisation et l'intégration efficaces avec d'autres outils de développement.

La rédaction d’un document produit nécessite de bonnes compétences en rédaction technique et des connaissances organisationnelles. Ce ne sont là que quelques exemples relevant de la rédaction technique qui nécessitent des niveaux élevés de compétences en recherche, en visualisation et la capacité de se connecter avec une grande variété de publics.

Astuce : « Demandez-vous : « Le titre suscite-t-il l'intérêt du lecteur ? » Si c'est le cas, ils se plongeront probablement dans l'introduction et décideront ensuite : « Est-ce que cela vaut la peine d'investir mon temps dans toute cette pièce ? Une erreur courante que j’observe souvent dans les articles techniques est un excès d’introduction ou, à l’inverse, pas assez.

Un paragraphe rédigé avec précision peut effectivement préparer le terrain pour un article de blog technique.

Comment commencer en tant que rédacteur technique

De loin, la question la plus courante que l’on me pose à propos de la « rédaction technique ou du blogging » concerne la façon de commencer.

Dans la vie, il semble que le plus grand obstacle pour faire quelque chose et devenir ce que vous voulez devenir est de commencer.

Le pire ennemi est le « doute de soi ». pic.twitter.com/fw1691QRSY
– Ankur💻🎧💪 (@TheAnkurTyagi) 10 août 2023

Qu'il s'agisse de démarrer un nouveau programme d'entraînement, de s'entraîner pour un marathon, de démarrer une entreprise, d'écrire un livre ou, plus précisément, dans ce cas, d'écrire, le plus difficile est toujours de commencer.

Il est facile – et tentant – de perdre d'innombrables heures à débattre de ce que vous devriez faire.

Il est beaucoup plus facile de « lire », « lire » et « étudier » que de commencer à « écrire ».

Mais le secret est qu’il suffit de faire un pas à la fois.

Créez au moins un actif composé dans votre carrière en génie logiciel

– Démarrer un blog – Démarrer une newsletter – Commencer à enregistrer des vidéos YT – Démarrer un podcast – Commencer à créer des réseaux
Construire, publier et répéter
De futures opportunités vous attendent sur Internet
Cc @TheAnkurTyagi
– Kap.ts (@Kaperskyguru) 17 février 2023

Et regardez autour de vous ; la plupart des développeurs en génie logiciel n'écrivent pas de code 24 heures sur 24, 7 jours sur 7 ; la plupart d’entre nous passent beaucoup de temps à faire autre chose chaque jour.

Qui comprend:

Démonstration d'une nouvelle fonctionnalité au sein de l'équipe au sein d'une entreprise ou de clients.
Documenter une nouvelle ou une ancienne fonctionnalité de votre produit.
Mise à jour d'un ticket JIRA lié.
Créer un retard de travail pour prendre en charge cette nouvelle fonctionnalité.

Bien sûr, il est toujours temps de faire des pauses toilettes/déjeuner et de faire défiler Twitter aussi 😉

alors ne réfléchis pas trop, commence simplement

"Ecrire, c'est comme apprendre à jouer au basket."
– David Perell

Pour réussir et trouver des opportunités, vous devez posséder 3 compétences.

Codage
En écrivant
Anglais

Oui, avant même de commencer à écrire, vous devez d'abord comprendre l'anglais, y compris ses temps, son orthographe et sa grammaire de base.

Vos lecteurs ne veulent pas lire un article truffé d’erreurs grammaticales et de mauvais choix de mots.

Dans l’industrie technologique, l’anglais est devenu de facto la langue de communication entre les développeurs de logiciels, les ingénieurs et autres professionnels de la technologie du monde entier. C'est le langage utilisé pour la documentation, les langages de programmation et les outils utilisés pour le développement.

Apprenez à communiquer des idées simplement et clairement

Savoir comment mettre en œuvre une fonctionnalité technique n’implique pas nécessairement que vous puissiez expliquer le processus aux autres.

Être un bon enseignant nécessite de l'empathie et la capacité de transmettre des informations d'une manière adaptée à votre public cible.

On ne comprend pas quelque chose si on ne peut pas l'expliquer à un enfant de six ans.
Einstein, Albert

Il n’existe pas de stratégie parfaite pour devenir un écrivain exceptionnel. Vous vous demandez peut-être pourquoi je parle de ce sujet. C'est parce qu'il est crucial d'aborder ce problème dès le début.

« Ne cherchez pas de stratégie ; recherchez votre voix unique dans l’écriture et construisez votre style.

Le seul hack d'écriture que vous devriez connaître.

Moins de technologie, c'est plus, je travaille avec React 90 % du temps.
Si vous écrivez pour la première fois, accordez-vous plus de temps pour comprendre.
Permettez-vous d’écrire mal.
Arrêtez de vous préparer et commencez à agir.

Comment devenir un écrivain hors pair à l'ère de l'IA :
Avant d'écrire votre prochain article de blog, demandez à ChatGPT d'en écrire un sur le sujet et de vous montrer quels éléments génériques sont déjà disponibles sur Internet afin que vous puissiez éviter de dire cela et écrire ce qui est important et unique pour le public.
– Ankur💻🎧💪 (@TheAnkurTyagi) 16 février 2023

Pour comprendre votre public, posez ces questions avant de commencer à écrire.

Qui sont vos lecteurs ?
Que recherchent-ils sur Google ou à quel problème sont-ils confrontés ?
Quels blogs lisent-ils actuellement ?
Comment vont-ils lire ?

Comment trouver des idées d'articles de blog

Écrivez l’article qui vous aurait évité de passer des heures à chercher sur Google et à vous gratter la tête.
Chaque fois que vous apprenez quelque chose de nouveau, écrivez comment vous l'avez appris et ce que vous avez appris.
Écrivez une histoire sur votre domaine, vos intérêts ou votre profession.
Sélectionnez un article de blog de votre blogueur préféré que vous avez trouvé agréable et explorez le même sujet sous un nouvel angle, ou abordez un sujet différent sous un angle similaire.

Écrivez le billet de blog que vous auriez aimé trouver lorsque vous avez recherché quelque chose sur Google.
– Ankur💻🎧💪 (@TheAnkurTyagi) 20 mars 2023

Remarque : Si vous avez fait quelque chose d'intéressant dans votre carrière en génie logiciel mais que vous le gardez pour vous, vous manquez un gros générateur d'opportunités.

Il est préférable de naviguer sur Internet par l'écriture lorsqu'il s'agit de promouvoir efficacement vos idées.

Il existe un endroit idéal pour rédiger des articles techniques et des didacticiels. Écrivez pour le professionnel qui n'a pas encore eu le temps d'apprendre cette chose et faites le lien avec des choses qu'il connaît déjà. Par exemple, expliquer une technique JS moderne à quelqu'un qui connaît jQuery.
– Rachel Andrew (@rachelandrew) 20 février 2019

Conclusion

L'écriture est un fruit à portée de main pour la plupart des développeurs qualifiés.

Si vous pensez que vous pouvez apprendre beaucoup de choses en technologie en lisant un article de blog ; essayez d'en écrire un cette semaine.
– Ankur💻🎧💪 (@TheAnkurTyagi) 2 octobre 2023

La raison pour laquelle chaque développeur devrait écrire un article de blog sur ce qu'il apprend en génie logiciel est que l'écriture lui fait découvrir qu'il ne comprend peut-être pas quelque chose aussi bien qu'il le pensait.

Enseigner et écrire sur n'importe quoi est le meilleur moyen d'en apprendre davantage, et c'est un fruit facile à saisir pour commencer un nouveau style de vie, car vous avez déjà une expérience directe, donc tout ce que vous avez à faire est de vous présenter, d'écrire un article de blog de 12. cette année, évaluez les résultats et planifiez votre prochain déménagement !

«Lisez pour rassembler les points, écrivez pour les relier.» – David Perell

L’essentiel est que perfectionner vos compétences rédactionnelles et déployer un petit effort supplémentaire dans votre écriture peut véritablement améliorer vos capacités en tant que développeur. Ces conseils pourraient vous être utiles pour collaborer avec d'autres développeurs, maintenir votre travail, créer votre contenu en cas de besoin ou même rédiger des propositions de projet, entre autres tâches.