Article original : How to write a great technical blog post
Par Sashko Stubailo
Cinq étapes pour passer de l'idée au résultat poli
Je travaille dans la communauté open source depuis presque 5 ans maintenant, construisant et promouvant des outils pour développeurs, y compris Meteor et Apollo. Durant cette période, j'ai découvert que le blogging est l'un des moyens les plus efficaces pour diffuser des idées.
Un article de blog ne prend pas autant de temps à préparer qu'une vidéo ou une conférence, mais il est facile à consommer et peut atteindre un grand nombre de personnes. J'ai également personnellement tiré beaucoup de bénéfices de l'écriture : cela m'a aidé à organiser mes pensées, à enseigner aux gens les technologies que j'aime, et à me faire connaître.
Depuis la publication de mon tout premier article de blog en 2014, j'ai fini par écrire 68 articles jusqu'à présent ici sur Medium, certains avec plus de 50k vues et 1000 fans, et j'ai édité de nombreux articles pour mes amis et collègues. Au fil du temps, j'ai acquis quelques stratégies pour transformer un article d'un concept à une publication.
Dans cet article, nous allons passer en revue cinq étapes principales de mon processus d'écriture d'un article :
- Trouver un bon sujet et s'y engager
- Rendre vos objectifs et votre public spécifiques
- Avoir un début, un milieu et une fin
- Obtenir des retours et itérer
- Ajouter les touches finales : emballage, publication et promotion
Commençons dès maintenant par la première étape !
1. Trouver un bon sujet et s'y engager
Vous ne pouvez pas commencer un article si vous n'avez rien à écrire ! Lorsque je parle à des personnes qui veulent commencer à bloguer, c'est souvent leur principal blocage.
La stratégie la plus simple est d'écrire sur ce que vous connaissez. Si vous avez passé de nombreuses heures à apprendre quelque chose, et que vous pensez pouvoir l'expliquer en quelques minutes, vous allez apporter beaucoup de valeur à vos lecteurs.
Une autre idée est d'écrire sur un domaine que vous pensez manquer de contenu. Par exemple, il n'y a pas beaucoup d'articles sur la façon de postuler à des conférences techniques, donc du contenu sur ce sujet pourrait combler une lacune dans la communauté.
Voici quelques types spécifiques d'articles que vous pourriez envisager. Les exemples sont tirés des articles liés à GraphQL sur le blog d'Apollo :
- Un guide étape par étape pour atteindre un objectif spécifique : "Créer une grande liste déroulante dans React Native avec FlatList" ou "Simplifiez vos composants React avec Apollo et Recompose". Ceux-ci sont parfaits pour les lecteurs qui veulent entrer, faire une chose et sortir rapidement.
- Une étude approfondie sur un sujet particulier : "Utilisation de la nullabilité dans GraphQL" ou "Anatomie d'une requête GraphQL". Ceux-ci sont utiles si vous ciblez un public plus intéressé qui veut prendre un café et apprendre beaucoup.
- Une liste numérotée de faits utiles autour d'un sujet commun : "4 façons simples d'appeler une API GraphQL" ou "5 avantages des requêtes GraphQL statiques". Ceux-ci sont une lecture amusante et légère puisque vous n'avez pas à vous engager à lire tout le contenu, et il est facile de consommer les morceaux de taille réduite.
Maintenant, laissez-moi dissiper quelques préoccupations courantes :
- Il existe déjà du contenu sur ce sujet. Ne laissez pas cela vous arrêter. Même si votre idée a déjà été écrite, vous pouvez y apporter votre propre perspective, ou la rendre spécifique à votre situation.
- Mon idée n'est pas assez intéressante. Beaucoup de mes amis et collègues ne finissent pas par écrire parce qu'ils s'inquiètent que leurs conclusions puissent être ennuyeuses ou évidentes. C'est un sentiment normal ! Si vous êtes un expert en quelque chose, alors bien sûr les conclusions que vous écrivez seront ennuyeuses... pour vous. L'important est que les gens dans votre public ne connaissent pas encore ces choses.
Ayant dit tout cela, à la fin de la journée, il est difficile de prédire quels sujets feront un excellent article et lesquels ne le feront pas, et souvent c'est l'exécution qui fait ou défait un article, pas un sujet brillant. Mon principal conseil serait d'essayer d'écrire sur plusieurs choses différentes et de voir ce qui fonctionne.
2. Rendre vos objectifs et votre public spécifiques
Maintenant que vous connaissez votre sujet, vous avez besoin d'un public et d'un objectif pour votre article. Qui va le lire, et qu'en retireront-ils ?
Votre objectif doit être spécifique afin que vous puissiez concentrer toute votre énergie sur une idée principale. Pour cet article, l'objectif n'aurait pas pu être simplement "écrire sur le blogging". J'avais besoin d'un objectif plus spécifique en tête :
- Public : Les personnes qui veulent commencer à bloguer, surtout sur des sujets techniques, mais qui ne l'ont pas encore fait.
- Objectif : Donner aux gens un ensemble concret d'étapes et de conseils pour qu'ils puissent commencer.
Une fois que vous avez ceux-ci, gardez votre article concentré en supprimant tout ce qui ne contribue pas, et évitez d'ajouter des détails supplémentaires simplement parce qu'ils sont liés. J'ai constaté que les articles relativement concis avec un temps de lecture de 5 à 10 minutes sont les plus réussis.
Connaître le contexte de votre public vous permettra d'adapter votre écriture à leurs connaissances existantes, et peut aider à déterminer comment vous devriez publier et promouvoir votre contenu. Par exemple, j'espère publier ceci sur freeCodeCamp, car beaucoup de gens dans mon public cible lisent peut-être déjà cette publication.
3. Avoir un début, un milieu et une fin
C'est désorientant lorsqu'un article s'écarte dans une direction à laquelle vous ne vous attendiez pas. Les rebondissements peuvent être un grand avantage dans les histoires courtes de fiction, mais il est plus facile de consommer un article technique si vous obtenez exactement ce à quoi vous vous attendez. Vous pouvez garder vos lecteurs sur la bonne voie en donnant à votre article une structure confortable.
Introduction
Les premiers paragraphes de votre article convaincront le lecteur de rester ou de perdre son attention. Commencez par un peu de contexte pour aider les gens à comprendre où votre article s'inscrit dans le grand schéma des choses. Ensuite, dites à votre public ce qu'ils retireront de la lecture de votre article. Il peut être tentant de garder la grande révélation pour la fin, mais attention : si vous n'avez pas un bon accroche, vos lecteurs ne resteront pas pour le découvrir.
Milieu
Maintenant que vous avez dit à vos lecteurs à quoi s'attendre, donnez-leur ! N'hésitez pas à entrer dans autant de détails que nécessaire, et laissez des panneaux indicateurs le long du chemin pour orienter les gens. Utilisez beaucoup de titres, de listes numérotées et de mise en forme pour aider les gens à comprendre où ils se trouvent, et leur permettre de sauter vers le contenu qui les intéresse le plus.
Conclusion
Ne vous évanouissez pas simplement dans le vide à la fin de l'article. Si votre lecteur est arrivé jusqu'au bout, c'est qu'il s'intéresse vraiment. Donnez-lui un rapide résumé de ce qu'il a appris, une tape dans le dos pour avoir lu, et peut-être même quelque chose à faire ensuite s'il est inspiré - un appel à l'action.
Le format que je suggère ici n'est pas le plus créatif, et il existe certainement d'autres façons de faire. Mais une structure simple est le moyen le plus direct de communiquer avec vos lecteurs.
4. Obtenir des retours et itérer
Vous ne saurez pas ce que les gens vont retirer de votre écriture jusqu'à ce qu'ils la lisent. C'est ici que vos hypothèses sur votre sujet, vos objectifs, les détails de l'article et la structure sont vraiment mises à l'épreuve. Si vous voulez avoir un bon résultat, vous ne pouvez pas sauter cette étape.
Il peut sembler que vous imposez lorsque vous demandez des retours, ou vous pourriez craindre qu'ils soient négatifs, mais les gens sont plus disposés à aider que vous ne le pensez. Il est beaucoup mieux de découvrir comment votre article pourrait être amélioré avant de le publier pour le monde entier. Lorsque je mettais ensemble cet article, j'ai obtenu des retours super précieux qui ont rendu le contenu beaucoup meilleur et plus ciblé.
Que devriez-vous demander à vos relecteurs ? Mon principal conseil est de laisser cela aussi ouvert que possible. Essayez de ne pas expliquer d'emblée ce que vous vouliez accomplir. Remettez le brouillon tel quel, et demandez à votre relecteur ce qu'il en a retiré ou ce qui devrait être changé. Lorsque quelqu'un sur Internet tombe sur votre article, il n'aura aucun contexte supplémentaire et il doit se suffire à lui-même.
La principale chose à valider à partir des retours est : cet article atteindra-t-il les objectifs que vous avez décisés à l'étape 2 ? Itérez jusqu'à ce que vous soyez confiant qu'il le fera.
5. Ajouter les touches finales : emballage, publication et promotion
Maintenant que vous avez l'idée, l'objectif, la structure et quelques retours, il est temps de tout polir et de le publier.
Emballage
Trouvez un excellent titre et sous-titre, et assurez-vous que votre article a au moins une image. C'est ce que les gens verront lorsque l'article sera partagé sur Twitter ou Facebook, et c'est votre chance de susciter l'intérêt des gens pour la lecture.
Il est également important que votre article ait l'air et se sente professionnel, afin que votre contenu puisse vraiment briller. Vous devriez viser à avoir aucune erreur d'orthographe, de grammaire ou de mise en forme étrange dans votre article. Si vous avez un ami qui est excellent pour repérer les petits détails, demandez-lui de le relire avant la publication.
L'article de freeCodeCamp sur la publication contient également quelques excellents conseils sur le style d'écriture et la mise en forme. Puisque vous avez déjà mis tant de travail dans votre article, cela vaut la peine d'ajouter cet effort supplémentaire pour vraiment le polir et lui donner une portée plus large.
Enfin, assurez-vous de créditer toute personne dont le travail vous avez référencé, ou qui a aidé à réviser et éditer votre article.
Publication
Vous y êtes presque ! Choisissez où vous publiez réellement l'article afin qu'il ait la meilleure chance d'atteindre votre public. Medium est généralement un excellent endroit pour le contenu technique et facilite la découverte de votre écriture par les gens.
Pour des points bonus, essayez de faire entrer votre article dans une publication pertinente qui aidera à partager votre contenu - dans ce cas, j'ai sélectionné freeCodeCamp parce que je pense que ces conseils seront pertinents pour leurs lecteurs. Si vous souhaitez faire de même, voici leurs instructions pour soumettre votre article. Les publications dans vos domaines d'intérêt recherchent probablement également des articles, alors n'hésitez pas à prendre contact !
Promotion
Une fois que vous avez réellement publié l'article, vous n'avez pas fini ! Si vous voulez que les gens voient ce que vous avez écrit et en tirent de la valeur, assurez-vous de le partager dans les endroits où votre public est susceptible de traîner. Cela peut inclure des groupes Facebook, Reddit, Hacker News, LinkedIn, ou toute autre plateforme. De plus, assurez-vous de partager votre création sur vos propres comptes de médias sociaux, comme Twitter. Vos amis seront ravis de lire, partager et voter pour ce que vous avez écrit !
Et maintenant, vous avez terminé. Allez prendre un café ou faites une promenade - amener un article de blog de début à fin n'est pas une mince affaire. Lisez tous les retours et réponses de la communauté afin de pouvoir continuer à vous améliorer. Et lorsque vous avez une autre idée, faites-le à nouveau !
Rien ne remplace la pratique
Nous venons de passer en revue cinq des choses les plus importantes à faire lors de l'écriture d'un article de blog, de la recherche de l'idée à la publication. Maintenant que vous l'avez lu, essayez d'appliquer ces conseils et voyez ce qui fonctionne pour vous.
Je vous laisse avec un dernier conseil. La principale chose que j'ai apprise du blogging au cours des 3 dernières années est que je ne peux absolument pas prédire quel contenu va décoller et lequel va finir par être un total échec. Parfois, je vais passer plusieurs jours sur un article, polissant chaque coin, et il n'ira nulle part. D'autre part, "GraphQL vs. REST", mon article le plus lu, a été écrit en quelques heures tard dans la nuit.
Alors, même si vos premier, deuxième ou troisième articles ne réussissent pas, continuez à essayer de nouvelles choses, à mettre vos idées là-bas et à vous améliorer avec le temps. Le monde veut entendre ce que vous avez à dire. Allez leur dire !
Un énorme merci à Anvisha Pai, Angela Zhang, Katie Siegel, et aux éditeurs de freeCodeCamp pour avoir aidé à réviser cet article.