Wie schreibst du technische Blogs? [geschlossen]

Normalerweise lese ich viel über das Programmieren. Wenn das Thema, das ich lese, nicht direkt mit meiner Arbeit zusammenhängt (z. B. das Lesen einiger Algorithmen, die ich im Arbeitsalltag nicht verwende), vergesse ich sie.

Eine Möglichkeit, das Gelernte zu bekräftigen, besteht darin, Blogs zu schreiben. Ich bin ein Anfänger im Schreiben von Blogs. Als ich anfing zu schreiben, stellte ich fest, dass es sehr schwierig ist. Selbst die einfache Wiedergabe des Inhalts dauert ungefähr zwei Stunden. Das Schreiben eines gut durchdachten Blogs dauert oft einen ganzen Tag oder manchmal ein Wochenende.

Ist das normal? Irgendwelche Tipps zum Schreiben von technischen Tutorials / technischen Blogs?

Schreiben ist schwer, gutes Schreiben ist noch schwerer. Die Sache mit dem Versuch, etwas zu erklären, ist, dass es mehr Wissen erfordert, als es nur "irgendwie zu wissen". Ich finde, dass ich durch Bloggen 1. verwandte Themen finde, die ich verstehen muss, 2. identifiziere, wo mein Verständnis oberflächlich ist

Lesen Sie diese Folien durch http://www.ai.uga.edu/mc/WriteThinkLearn.pdf . Sie erklären viel über das Schreiben (und vergleichen es sogar mit dem Programmieren)

Jede Qualitätsarbeit erfordert Zeit und Mühe. Es ist zu erwarten.

Einige meiner älteren Blog-Arbeiten haben ungefähr 3 Wochen gedauert. Sie schreiben einen Entwurf, lesen ihn erneut, nehmen die erforderlichen Korrekturen vor, scannen ihn erneut und lesen ihn dann durch. Es braucht Zeit.

Eine einfache Idee, um sich selbst zu motivieren. Wenn Sie etwas Großes planen, überlegen Sie, ob es Sinn macht, das Werk in 2-3 Teile zu teilen und diese getrennt zu veröffentlichen. Die Teile müssen natürlich für Ihre Leser selbst nützlich sein. Dann, da sie weniger Zeit in Anspruch nehmen, ist es wahrscheinlicher, dass Sie es schaffen und die Teilarbeiten zum Abschluss bringen.

Einige Tipps von diesem unbekannten technischen Blogger:

• Überprüfen Sie den eingegebenen Code, indem Sie ihn ausschneiden und von der Vorschau in die Befehlszeile oder in eine auszuführende Textdatei einfügen (nicht nur lesen). Bei der Übertragung von einem Editor (oder einer Shell) auf eine Webseite und zurück können verschiedene Dinge (z. B. Zeilenenden, Einrückungen und Unicode-Zeichen) durcheinander geraten.
• Holen Sie sich ein Mensch auf Rechtschreibung, Grammatik und überprüfen - Es zeigt , dass einige Mühe in die Herstellung gingen die Artikel korrigieren und leicht zu lesen. Wenn niemand in der Nähe ist, lesen Sie den gesamten Artikel vor der Veröffentlichung erneut.
• Wenn die Blogging-Plattform über Syntaxhervorhebungen verfügt , verwenden Sie diese. Wenn nicht, posten Sie den Code an einer beliebigen Stelle und verlinken Sie ihn dort.
  • Fazit: Halten Sie große Codestücke vom Artikeltext fern. Dies ist ein bisschen vage, aber wenn der Text erklärt, wie ein Code funktioniert, ist es in Ordnung, ein Snippet einzuschließen. Wenn eine Software zum Herunterladen angeboten wird, ist es besser, auf eine VCS-Webschnittstelle zu verweisen.
• Jeder Artikel sollte für sich allein lesbar sein . Es ist in Ordnung, auf andere Artikel zu verweisen, aber nehmen Sie nicht einfach an, dass der Leser vor diesem Artikel andere Beiträge gelesen hat.
• Verwenden Sie andere Formate als Text, wenn sie das Verständnis erleichtern. Für manche Dinge reicht der Code aus, für andere sind Bilder oder sogar Animationen möglicherweise viel verständlicher.

Oft stelle ich fest, dass ein schwieriger Blogbeitrag so lange dauert, weil er recherchiert werden muss. Diese Recherche hilft nicht nur Ihrem Blogbeitrag, sondern hilft Ihnen auch dabei, Ihr persönliches Wissen aufzubauen. Wie Sie sagten, stärken Sie Ihr Wissen, indem Sie den Beitrag schreiben. Sie erweitern auch Ihr Wissen. Nehmen Sie die erforderliche Zeit in Anspruch und schätzen Sie sie als Lernerfahrung.

Ja, es ist normal, dass das Verfassen von technischen Blogs einige Zeit in Anspruch nimmt. Für mich dauert das Schreiben am kürzesten (je nach Länge bis zu einer Stunde oder bis zu einem Tag). Dann dauert das Bearbeiten und Umschreiben in der Regel länger (bis zu zwei oder sogar drei Tage). Ein weiterer Aspekt, der erwähnt wurde und einige Zeit in Anspruch nimmt, ist die Klärung von Beispielcode. Außerdem verbringe ich gerne Zeit damit, unterstützende Links für meine Themen zu finden. Das alles braucht Zeit!

Ich schätze, Sie könnten jetzt technische Blogs schreiben. Ich würde Ihnen jedoch empfehlen, dies zu tun, wenn Sie Experte auf einem bestimmten Gebiet werden. Ein Wochenende zu verbringen scheint nicht zu viel Zeit zu sein. Alles hängt von der Komplexität des Themas ab. Ich denke, was ich sage, ist, dass der Kern Ihrer Idee auf natürliche Weise zu Ihnen kommt. Die Ausführung könnte (und wird) länger dauern.

Die Leute suchen nach Expertenrat in einem Blog .. keine noobs Experimente. Aber ich spreche im Allgemeinen. Ich möchte Sie nicht davon abhalten, Blogs zu schreiben. Beachten Sie jedoch die folgenden Punkte.

1. Dein Blog sollte etwas Neues sagen. Sammeln Sie nicht nur Daten und stellen Sie sie auf Ihren eigenen Blog

2. Seien Sie sich absolut sicher, was Sie sagen, dh halten Sie sich an fundierte empirische Ergebnisse oder erprobte Konzepte oder Dinge, die Sie aus erster Hand erfahren haben .

3. Seien Sie bereit für Kritik.

4. Erlernen der Techniken zum Schreiben von Blogs (Genauigkeit, Prägnanz usw.)

5. Schreiben Sie etwas, weil Sie denken, dass es geschrieben werden soll; nicht, weil du denkst, dass es gelesen wird.

Die Elemente des Stils

Ich denke, das technische Schreiben folgt weitgehend den gleichen Regeln wie jedes Schreiben. Wenn Sie nur ein Buch über das Schreiben lesen, sollte es der Klassiker "The Elements of Style" sein . Es geht durch eine Liste von Dingen, die Ihre Komposition verbessern werden. Das Wichtigste ist (IMO): "Überflüssige Worte weglassen".

Ich würde auch Stephen Kings " On Writing " empfehlen . Während es sich mehr um fiktives Schreiben handelt, enthält es dennoch eine Menge Juwelen für jeden aufstrebenden Schriftsteller, insbesondere in Bereichen wie dem Bearbeiten und dem Schreiben.

Das Schwierigste am technischen Schreiben ist jedoch nicht das eigentliche Schreiben, sondern das Klären Ihrer Gedanken über das, worüber Sie schreiben. Verwirrtes Denken führt zu schlechtem Schreiben. Gutes Schreiben setzt voraus, dass Sie ein klares Verständnis für Ihr Thema haben. Deshalb eignet sich Lehren und Schreiben hervorragend, um ein Thema zu meistern.

Nun, ich brauche sehr viel Zeit, um Blog-Beiträge zu schreiben, ja. Ich schreibe sie häufig über mehrere Tage oder lasse sie sogar ein paar Wochen in Entwurfsform, lese sie gelegentlich noch einmal durch und korrigiere und optimiere sie hier und da ein wenig.

Es braucht Zeit, aber wenn das der Preis ist, um etwas zu schreiben, für das ich mich nicht schäme, dann ist es das wert.