Récemment, il y a deux articles, un centième article a été publié dans notre hub d'entreprise. En l'honneur du numéro rond, nous avons décidé de résumer un peu notre expérience. Dans cet article, nous expliquerons comment nos développeurs travaillent sur les articles, ce qui les aide à écrire et à quoi faire attention lorsqu'ils travaillent sur du texte.
Pour commencer, répondez simplement à deux questions simples:
- Pourquoi ai-je besoin de ça?
- Que vais-je dire d'intéressant et d'utile à la communauté habra?
Ensuite, vous pouvez prendre le plan de cet article (ou créer le vôtre) et le faire.
Il y a des étapes créatives et techniques. Cet article concerne la création. Considérez:
- Pourquoi écrire des articles
- Où trouver le sujet de l'article,
- Où trouver le temps de l'écrire,
- Les principales étapes de travail sur le texte,
- Que faire si l'article ne part pas,
- Et par où commencer si vous n'avez jamais écrit en Habr.
Nous espérons que le texte sera utile à d'autres auteurs Habr, y compris les auteurs potentiels.
Motivation: pourquoi devrais-je, en tant que développeur, écrire dans Habr
Il n'y a pas de réponse unique et il n'y a pas de solution miracle. Par conséquent, nous donnons les réponses de nos employés, où chacun peut se reconnaître, et nous écouterons avec plaisir, comme vous.
- Socialisation
L'empathie et le sens de la communauté motivent - je veux partager des émotions et des réflexions sur le processus de développement avec une communauté intéressée. - Organisez vos connaissances
J'aime l'ordre dans ma tête, et écrire un article ou le texte final en général peut accélérer la recherche de lacunes dans la compréhension et la connaissance du sujet. L'article vous permet de regarder le sujet sous différents angles, de découvrir pleinement tous les moments incompréhensibles, de réaliser quelque chose. - L'intérêt trie le nouveau et partage
Il se motive à écrire sur quelque chose de nouveau pour lui-même, sur ce qui est frais dans le monde du développement. Si je faisais des tâches typiques, je ne pense pas qu'il y aurait une sorte d'épuisement de cela. Dans l'ensemble, la sortie est une instruction avec ou sans blagues, qui ressemble à une réponse détaillée avec Stack Overflow sur la question / le sujet posé dans le titre de l'article. - Gagnez du temps sur la formation à l'intérieur
L'article est un recueil pour les collègues qui doivent encore le dire plus tard. Et il a donc écrit - et envoyé ou dirigé un séminaire. - Obtenir des commentaires et des commentaires de l'entreprise
C'est assez agréable d'avoir des vues et des avantages dans la compensation, cela améliore le karma. Un karma amélioré vous motive également à écrire davantage. Dans les commentaires, vous pouvez trouver des informations utiles par les gars qui ont fait de même et qui ont déjà rempli les bosses. - Pour le meilleur
Il est inspiré par le désir d'accélérer le développement de l'humanité - si une activité de l'auteur permet aux gens de gagner plus de temps qu'il n'en a dépensé - en moyenne, l'humanité est susceptible de bénéficier du développement, car le temps économisé sera probablement consacré à des activités utiles.
Le choix d'un sujet compte tenu de l'utilité pour Habr
Lors du choix des sujets, nous nous concentrons sur notre expérience subjective et nos cas pratiques, que nous avons passés en revue et testés nous-mêmes. Bien sûr, on suppose que nous avons étudié la littérature à l'avance et ne répéterons pas ce qui a déjà été écrit. Et selon les règles de bonne forme, nous nous référons toujours à des sources utiles.
Bons sujets
- Il existe des solutions sur lesquelles les développeurs disent: "Il n’y avait pas de documentation officielle à ce sujet, sur Habré aussi. J'ai dû bricoler. " Si la décision elle-même est décente, alors l'article sera bon.
- Certains sujets découlent du défi mondial posé par le projet - par exemple, fournir une haute disponibilité et un CI / CD transparent. Chaque étape vers cet objectif - migration vers .Net Core, Docker, etc. - peut être décrite dans un article séparé. Aux rallyes, une blague «dans un article!» Saute souvent, c'est-à-dire collègues comme si cela faisait allusion.
- Une partie du sujet survient lorsque vous recherchez activement un nouveau sujet. Il y a un signe: si le développeur a passé plus de 4 heures à rechercher sur Google ou à lire d'autres articles, alors il vaut la peine de compiler les informations trouvées, ou peut-être d'écrire quelque chose de nouveau.
- Certains textes sont nés après avoir lu un livre intéressant, assisté à une bonne conférence ou même comme documentation interne - je veux partager de nouvelles connaissances.
Ce qui est bénéfique est bon, permet aux lecteurs de gagner du temps à l'avenir et donne une expérience pratique, plutôt que des spéculations philosophiques sur la paix dans le monde.
Mauvais sujets
Ils sont nombreux, mais nous en citerons quelques-uns:
- Une répétition de tout ce qui est connu dans le seul but de l'indexation par mots clés,
- Publicité directe ou indirecte d'une entreprise ou d'un client (voir avec qui je travaille),
- Un article sur rien ou un flux de pensées sans structure.
En général, tout est mauvais qui ne profite pas au lecteur ou ne le respecte pas.
Les principales étapes du travail sur le texte
Pour l'auteur, le travail sur les textes passe par 6 étapes créatives:
- Définition d'objectifs: formulation d'un thème, d'une idée et d'un plan. Pour trouver un sujet, nous répondons aux questions «Quelles nouveautés les lecteurs apprendront-ils de cet article», «Pour qui nous l'écrivons», «Que voulons-nous exactement partager». Il est également important pour nous que l'article apporte quelque chose de nouveau. Pour ce faire, nous regardons les mots clés qui ont déjà été écrits sur ce sujet et si nous nous répétons.
- Notes ou journal de laboratoire. Au cours du travail sur la tâche, les développeurs prennent des notes: enregistrez des liens utiles, écrivez des ancres de rappel pour les situations d'urgence, afin que vous puissiez ensuite procéder à la rétro-ingénierie des notes en texte lisible. En ce qui concerne le texte, il ne reste plus qu'à relire le "journal de laboratoire", à reformuler certaines notes en utilisant un vocabulaire plus ou moins généralement accepté, puis à les assembler dans un ordre logique.
L'un de nos auteurs utilise l'éditeur de démarque en ligne hackmd.io, où il corrige ses étapes de développement du sujet. Cet outil vous permet de partager du texte, de montrer les progrès de l'article et, surtout, de le faire à l'avance. En conséquence, nous obtenons un texte dans lequel publier sur Habr il suffit d'ajouter une coupe et de donner quelques petits traits. C'est pratique pour contrôler la structure et la mise en page du texte.
- Organisez le texte. Nous écrivons les principales pensées et examinons leur utilité et leur place dans la structure de l'article. La table des matières est obtenue, c'est-à-dire le regroupement du texte en blocs sémantiques qui peuvent être perçus sans même lire d'autres sections.
- Nous éditons et éditons pour qu'un étranger «hors sujet» puisse plus ou moins comprendre le sens de ce qui a été dit. Vous pouvez relire au moins une fois par jour et modifier ce que vous n'aimez pas. L'édition prend plusieurs itérations, tout comme le travail sur le texte. À ce stade, nous examinons la langue et les erreurs - le texte non vérifié est lu comme s'il avait été écrit par un écolier-deux.
- Nous regardons le texte à travers les yeux des autres : l'article est lu par un autre développeur ou PM qui est compétent dans ce sujet. Un regard neuf et une critique constructive améliorent le produit.
- Nous préparons le texte pour l'impression. Nous apportons les dernières modifications, réfléchissons aux illustrations, choisissons les hubs appropriés - et imprimons!
La séquence de ces étapes n'est pas stricte. Il arrive que l'auteur dresse d'abord un plan, révèle chaque élément et le détaille au niveau souhaité, puis corrige le texte en plusieurs itérations. Et il arrive qu'au début, le développeur expose la solution à la tâche de travail, et déjà sur cette base, le texte pour Habr est né. À tout moment, d'autres collègues peuvent rejoindre l'article pour aider avec une idée ou un conseil.
Et maintenant des plans à l'action. C'est-à-dire au texte.
Beaucoup de tâches: comment trouver du temps pour travailler sur le texte
Travailler sur des textes dans le style de «remettre toutes les tâches et partir avec sa tête» ne fonctionne pas pour nous à cause du
facteur bus . Par conséquent, les auteurs sont progressivement engagés dans l'article en arrière-plan du reste de l'ouvrage. Souvent, le texte est un recueil de la tâche de travail réelle.
Un de nos auteurs a comparé ce travail avec des tests. Au début, vous pensez qu'il n'y a pas de temps pour écrire des tests. Ensuite, vous intégrez cette activité dans le processus - et il s'avère qu'il reste du temps. Les textes, comme les tests, aident à comprendre ce qui se passe. Même si vous allouez à l'article toutes les heures, cela fonctionnera. Bien sûr, si c'est important pour une personne.
Un autre écrit strictement le matin. Première chose d'abord. Sachant qu'il lui reste beaucoup de travail à accomplir, il peut consacrer 20 minutes au texte dès le début de la journée de travail. Dans de telles circonstances, il se révèle écrire de manière claire, concise et sur le cas.
Je veux écrire un article sur Habr et j'ai même proposé un sujet. Par où commencer?
Il n'y a rien de nouveau dans ce problème. Stephen King, George Orwell, Edgar Allan Poe, les camarades Strugatsky, le duo Henry Lyon Oldie, Richard Feynman et de nombreux autres auteurs sous une forme ou une autre ont déclaré:
"Si vous voulez commencer quelque chose (écrire un article, un livre ou une lettre à un ami), mais vous ne pouvez toujours pas le faire - il n'y a pas de temps et de situation mieux pour le faire que ... en ce moment!"
L'un de nous aide à ouvrir un éditeur de texte et à y diffuser un flux de réflexions sur le sujet. Très probablement, il s'avère alors que c'est «tout faux», mais la première étape a été franchie - le travail sur l'article a commencé.
Il existe un autre moyen: trouver un autre employé et lui parler du sujet de l'article. Et pour commencer l'histoire avec les mots: "Eh bien, en bref ...". Et dès que les premières pensées se sont déversées, criant "Merci!" fuyez et écrivez votre histoire de toute urgence. En termes simples, avec des tapis de production, que vous remplacez ensuite par quelque chose de constructif.
Et pour une collation, le chemin du classique est strictement sous votre responsabilité.
J'écris, j'écris, je suis coincé. Que faire
Trois scénarios peuvent être appliqués à la situation:
- Prenez une tasse de thé et détendez-vous. Vous n'avez certainement pas besoin de vous forcer lorsque le texte "ne va pas" - rien de bon ne vient d'un tel dépassement. Il ne s'agit d'ailleurs pas uniquement d'écrire des articles.
Mais jeter un emploi n'en vaut pas la peine. Dès que vous sentez que vous êtes plus ou moins détendu - relisez ce qui est écrit, c'est sûr qu'une autre pensée vous viendra à l'esprit. Dessinez un contour de la structure du texte. Envoyez du texte à un collègue.
Faites quelque chose autour du texte, mais n'extorquez pas les mots. Ensuite, les pensées elles-mêmes commenceront à fourmiller et il ne faudra que les saisir par la queue - et les mettre, telles quelles, sur papier / dans un éditeur de texte. - Rake tout le matériel dans la version de l'article tout "tel quel". À ce stade, vous devez terminer d'écrire les principales pensées ou conclure logiquement par la conclusion qu'il y en a. Si cela semble bon, le reste peut être déplacé vers l'article suivant.
- Une stupeur profonde et prolongée peut signifier que le sujet n'est pas proche et que vous n'avez pas besoin d'écrire à ce sujet. Il est préférable de couper ces sujets au premier stade. Ou consultez un collègue.
Si vous avez d'autres options, comment sortir d'une stupeur créative - partagez-la dans les commentaires.
En conclusion
Écrivez. N'écoutez personne et n'écrivez pas. C'est bien. Et vous écrirez bien - généralement excellent. Et puis l'habro-communauté deviendra intelligente, jurera et s'enrichira.
Enfin, des liens utiles vers ce sujet:
Partagez vos recettes dans les commentaires, attendez!