Comment écrivez-vous les blogs techniques? [fermé]

Je lis généralement beaucoup de choses sur la programmation. Lorsque le sujet que je lis n'est pas directement lié à mon travail (disons la lecture de certains algorithmes que je n'utilise pas au quotidien), je les oublie.

Une façon de renforcer ce qui a été appris est d'écrire des blogs. Je suis un débutant dans l'écriture de blogs. Quand j'ai commencé à écrire, j'ai compris que c'était très difficile. Même la simple reproduction du contenu prend environ deux heures. Écrire un blog bien pensé prend souvent une journée entière ou parfois un week-end.

Est-ce normal? Des conseils pour rédiger des tutoriels techniques / blogs techniques?

L'écriture est difficile, une bonne écriture est encore plus difficile. Le fait d'essayer d'expliquer quelque chose, c'est que cela nécessite plus de connaissances que de "savoir un peu". Je trouve qu'en bloguant 1. je découvre des sujets connexes que je dois comprendre, 2. j'identifie où ma compréhension est superficielle

Lisez ces diapositives http://www.ai.uga.edu/mc/WriteThinkLearn.pdf . Ils expliquent beaucoup sur l'écriture (et la comparent même à la programmation)

Tout travail de qualité demande du temps et des efforts. Il faut s'y attendre.

Certains de mes écrits de blog plus anciens ont pris environ 3 semaines. Vous rédigez un brouillon, le relisez, effectuez les corrections nécessaires, le relisez puis relisez-le. Ça prend du temps.

Une idée simple pour rester motivé. Si vous prévoyez quelque chose de grand, demandez-vous s'il serait judicieux de diviser le travail en 2-3 parties et de les publier séparément. Les parties doivent bien sûr être utiles à vos lecteurs par elles-mêmes. Ensuite, comme ils prennent moins de temps, vous êtes plus susceptible de terminer et de terminer le travail partiel.

Quelques conseils de ce blogueur technique inconnu:

• Vérifiez (et pas seulement lire) le code que vous avez entré en coupant et collant de l'aperçu vers la ligne de commande ou un fichier texte à exécuter. Plusieurs choses (comme les fins de ligne, l'indentation et les caractères Unicode) peuvent être gâchées lors du transfert d'un éditeur (ou d'un shell) vers une page Web et vice-versa.
• Demandez à un humain de vérifier l'orthographe, la grammaire et le contenu - Cela montre que des efforts ont été faits pour rendre les articles corrects et faciles à lire. Si personne n'est là, assurez-vous de relire l'intégralité de l'article avant de le publier.
• Si la plate-forme de blogging possède une coloration syntaxique , utilisez-la. Sinon, affichez le code quelque part qui l'a et liez-le.
  • Corollaire: éloignez de gros morceaux de code du texte de l'article. C'est un peu vague, mais si le texte explique comment certains codes fonctionnent, il est bon d'inclure un extrait. S'il présente un logiciel à télécharger, il est préférable de se référer à une interface Web VCS.
• Chaque article doit être lisible seul . Faire référence à d'autres articles est bien, mais ne supposez pas simplement que le lecteur a lu d'autres articles avant celui-ci.
• Utilisez d' autres formats que du texte lorsqu'ils facilitent la compréhension. Pour certaines choses, le code est suffisant, mais pour certains, une image ou même une animation peut être beaucoup plus compréhensible.

Souvent, je trouve qu'un article de blog difficile prend tellement de temps car il nécessite des recherches; cette recherche n'aide pas seulement votre article de blog, mais elle vous aide à développer vos propres connaissances personnelles dans le processus. Comme vous l'avez dit, vous renforcez les connaissances en écrivant le post; vous élargissez également vos connaissances. Embrassez le temps qu'il faut et appréciez-le comme une expérience d'apprentissage.

Oui, il est normal que la rédaction d'un blog technique prenne du temps. Pour moi, l'écriture prend le temps le plus court (aussi court qu'une heure, ou jusqu'à un jour, selon la durée). Ensuite, l'édition et la réécriture prennent généralement plus de temps (jusqu'à deux ou même trois jours). Un autre aspect mentionné qui prend du temps est la clarification de tout exemple de code. Aussi, j'aime passer du temps à trouver des liens de support pour mes sujets. Tout cela prend du temps!

Je suppose que vous pourriez écrire des blogs techniques maintenant, mais je vous suggère de le faire lorsque vous devenez expert dans un domaine particulier. Passer un week-end ne semble pas trop de temps. tout dépend de la complexité du sujet. Je suppose que ce que je dis, c'est que le cœur de votre idée devrait vous venir naturellement L' exécution pourrait (et prendra) plus de temps.

Les gens recherchent des conseils d'experts dans un blog .. pas une expérience noobs. mais je parle dans un sens général .. Je ne veux pas vous décourager d'écrire des blogs. Mais gardez à l'esprit les choses suivantes.

1. Votre blog devrait dire quelque chose de nouveau. Ne vous contentez pas de collecter des données et de les publier sur votre propre blog

2. Soyez absolument sûr de ce que vous dites, c'est-à-dire que vous vous en tenez à des résultats empiriques solides ou à des concepts ou des choses hautement éprouvés que vous avez expérimentés de première main .

3. Soyez prêt pour la critique.

4. Apprenez les techniques de rédaction de blogs (précision, concision, etc.)

5. Écrivez quelque chose parce que vous pensez que cela devrait être écrit; non pas parce que vous pensez qu'il sera lu.

Les éléments du style

Je pense que la rédaction technique suit à peu près les mêmes règles que toute écriture. Si vous ne lisez qu'un seul livre sur l'écriture, ce devrait être le classique Strunks "The Elements of Style" . Il passe par une liste de choses qui amélioreront votre composition, le plus important étant (IMO), "Omettez les mots inutiles".

Je recommanderais également " On Writing " de Stephen King . Tout en étant davantage sur l'écriture de fiction, il contient toujours de nombreuses gemmes pour tout écrivain en herbe, en particulier dans des domaines tels que l'édition et le processus d'écriture.

Cela étant dit, la difficulté de l'écriture technique n'est pas l'écriture proprement dite, mais la clarification de vos réflexions sur la chose que vous écrivez. Une pensée confuse mène à une mauvaise écriture. Une bonne écriture exige que vous ayez une compréhension claire de votre sujet, c'est pourquoi l'enseignement et l'écriture sont un excellent moyen de maîtriser un sujet.

Eh bien, cela me prend énormément de temps pour écrire des articles de blog, oui. Je les écris fréquemment sur plusieurs jours, ou même les laisse sous forme de brouillon pendant quelques semaines, les relisant de temps en temps et les corrigeant et les ajustant un peu ici et là.

Cela prend du temps, mais si c'est le prix pour écrire quelque chose dont je n'ai pas honte après, je pense que ça vaut le coup.