Vor zwei Artikeln wurde kürzlich ein hundertster Artikel in unserem Unternehmenszentrum veröffentlicht. Zu Ehren der runden Nummer haben wir beschlossen, unsere Erfahrungen ein wenig zusammenzufassen. In diesem Artikel erfahren Sie, wie unsere Entwickler an Artikeln arbeiten, was ihnen beim Schreiben hilft und worauf sie bei der Arbeit an Text achten müssen.
Beantworten Sie zunächst zwei einfache Fragen:
- Warum brauche ich das?
- Was werde ich der Habra-Community interessant und nützlich erzählen?
Dann können Sie den Plan aus diesem Artikel übernehmen (oder Ihren eigenen erstellen) und ihn ausführen.
Es gibt kreative und technische Phasen. Dieser Artikel handelt von kreativ. Bedenken Sie:
- Warum Artikel schreiben?
- Woher bekomme ich das Thema für den Artikel?
- Wo finde ich die Zeit, es zu schreiben?
- Die Hauptphasen der Arbeit am Text,
- Was tun, wenn der Artikel nicht erscheint?
- Und wo soll ich anfangen, wenn Sie noch nie in Habr geschrieben haben?
Wir hoffen, dass der Text für andere Habr-Autoren nützlich sein wird, auch für potenzielle.
Motivation: Warum sollte ich als Entwickler in Habr schreiben?
Es gibt keine einzige Antwort und keine Silberkugel. Deshalb geben wir die Antworten unserer Mitarbeiter, bei denen sich jeder wiedererkennen kann, und wir hören Ihnen gerne zu.
- Sozialisation
Empathie und Gemeinschaftsgefühl motivieren - ich möchte Emotionen und Gedanken über den Entwicklungsprozess mit einer interessierten Gemeinschaft teilen. - Organisieren Sie Ihr Wissen
Ich mag die Reihenfolge in meinem Kopf, und das Schreiben eines Artikels oder des endgültigen Textes im Allgemeinen kann die Suche nach Lücken im Verständnis und Wissen über das Thema beschleunigen. Der Artikel ermöglicht es Ihnen, das Thema aus verschiedenen Blickwinkeln zu betrachten, alle unverständlichen Momente vollständig herauszufinden und etwas zu realisieren. - Interesse sortieren das Neue und teilen
Er motiviert, über etwas Neues für sich selbst zu schreiben, über das, was in der Entwicklungswelt frisch ist. Wenn ich typische Aufgaben erledigen würde, würde es meiner Meinung nach keine Abgase geben. Im Großen und Ganzen ist die Ausgabe eine Anweisung mit oder ohne Witze, die einer detaillierten Antwort mit Stapelüberlauf auf die im Artikeltitel gestellte Frage / das Thema ähnelt. - Sparen Sie Zeit beim Training im Inneren
Der Artikel ist ein Kompendium für Kollegen, die es später noch erzählen müssen. Und so schrieb er - und sandte ein Seminar aus oder leitete es. - Feedback und Unternehmenskommentare erhalten
Es ist sehr schön, Ansichten und Pluspunkte in der Aufrechnung zu bekommen, es verbessert das Karma. Verbessertes Karma motiviert Sie auch, weiter zu schreiben. In den Kommentaren finden Sie nützliche Informationen für sich selbst von den Jungs, die den gleichen Weg gegangen sind und die Unebenheiten bereits aufgefüllt haben. - Zum Besten
Es ist inspiriert von dem Wunsch, die Entwicklung der Menschheit zu beschleunigen - wenn eine Aktivität des Autors den Menschen mehr Zeit spart als er -, wird die Menschheit im Durchschnitt wahrscheinlich von der Entwicklung profitieren, da die eingesparte Zeit wahrscheinlich für nützliche Aktivitäten aufgewendet wird.
Die Wahl eines Themas unter Berücksichtigung des Nutzens für Habr
Bei der Auswahl der Themen konzentrieren wir uns auf unsere subjektiven Erfahrungen und praktischen Fälle, die wir selbst durchlaufen und getestet haben. Natürlich wird davon ausgegangen, dass wir Literatur im Voraus studiert haben und nicht wiederholen werden, was bereits geschrieben wurde. Und nach den Regeln der guten Form verweisen wir immer auf nützliche Quellen.
Gute Themen
- Es gibt Lösungen, zu denen Entwickler sagen: „Es gab keine offizielle Dokumentation dazu, auch nicht zu Habré. Ich musste basteln. " Wenn die Entscheidung selbst anständig ist, ist der Artikel gut.
- Einige Themen ergeben sich aus der globalen Herausforderung des Projekts - beispielsweise die Bereitstellung von Hochverfügbarkeit und transparentem CI / CD. Jeder Schritt in Richtung dieses Ziels - Migration zu .Net Core, Docker usw. - kann in einem separaten Artikel beschrieben werden. Bei Kundgebungen überspringt ein Witz „in einen Artikel!“ Oft, d. H. Kollegen als Andeutung.
- Ein Teil des Themas kommt, wenn Sie aktiv nach einem neuen Thema suchen. Es gibt ein Zeichen: Wenn der Entwickler mehr als 4 Stunden bei Google recherchiert oder andere Artikel gelesen hat, lohnt es sich, zumindest die gefundenen Informationen zusammenzustellen oder vielleicht etwas Neues zu schreiben.
- Einige Texte entstehen nach dem Lesen eines interessanten Buches, der Teilnahme an einer guten Konferenz oder sogar als interne Dokumentation - ich möchte neues Wissen teilen.
Was von Vorteil ist, ist gut, spart den Lesern in Zukunft Zeit und gibt praktische Erfahrungen, anstatt philosophische Spekulationen über den Weltfrieden.
Schlechte Themen
Es gibt sehr viele von ihnen, aber wir werden einige von ihnen erwähnen:
- Eine Wiederholung von allem, was nur zum Zweck der Indizierung nach Schlüsselwörtern bekannt ist.
- Direkte oder indirekte Werbung für ein Unternehmen oder einen Kunden (siehe mit wem ich zusammenarbeite),
- Ein Artikel über nichts oder einen strukturlosen Gedankenstrom.
Im Allgemeinen ist alles schlecht, was dem Leser nicht zugute kommt oder ihn nicht respektiert.
Die Hauptphasen der Arbeit am Text
Für den Autor durchläuft die Arbeit an den Texten 6 kreative Phasen:
- Zielsetzung: Formulierung eines Themas, einer Idee und eines Plans. Um ein Thema zu finden, beantworten wir die Fragen „Was lernen die Leser neu aus diesem Artikel?“, „Für wen wir es schreiben“, „Was genau möchten wir teilen?“. Für uns ist es auch wichtig, dass der Artikel etwas Neues bringt. Dazu schauen wir uns die Schlüsselwörter an, die bereits zu diesem Thema geschrieben wurden, und ob wir uns wiederholen.
- Notizen oder Laborjournal. Während der Arbeit an der Aufgabe machen sich Entwickler Notizen: Speichern Sie nützliche Links, schreiben Sie Erinnerungsanker für Notfallsituationen, damit Sie Notizen in lesbaren Text zurückentwickeln können. Wenn es um den Text geht, müssen Sie nur das "Laborjournal" erneut lesen, einige Notizen mit mehr oder weniger allgemein anerkanntem Vokabular neu formulieren und sie dann in einer logischen Reihenfolge zusammenstellen.
Einer unserer Autoren verwendet den Online-Markdown-Editor hackmd.io, in dem er seine Schritte bei der Entwicklung des Themas festlegt. Mit diesem Tool können Sie Text freigeben, den Fortschritt des Artikels anzeigen und vor allem - um ihn im Voraus zu erstellen. Als Ergebnis erhalten wir einen Text, in dem wir auf Habr veröffentlichen können. Es reicht aus, einen Schnitt hinzuzufügen und ein paar kleine Striche zu machen. Dies ist praktisch, um die Struktur und das Layout des Textes zu steuern.
- Ordnen Sie den Text. Wir schreiben die Hauptgedanken auf und betrachten ihre Nützlichkeit und ihren Platz in der Struktur des Artikels. Man erhält das Inhaltsverzeichnis, dh das Clustering von Text in semantische Blöcke, die wahrgenommen werden können, ohne andere Abschnitte zu lesen.
- Wir bearbeiten und bearbeiten, damit ein Außenstehender, der nicht im Thema ist, die Bedeutung des Gesagten mehr oder weniger verstehen kann. Sie können jeden Tag mindestens einmal neu lesen und bearbeiten, was Ihnen nicht gefällt. Die Bearbeitung dauert mehrere Iterationen, ebenso wie die Arbeit am Text. In dieser Phase betrachten wir die Sprache und die Fehler - der nicht überprüfte Text wird so gelesen, als ob er von einem Schüler geschrieben wurde.
- Wir betrachten den Text mit den Augen anderer : Der Artikel wird von einem anderen Entwickler oder PM gelesen, der in diesem Thema kompetent ist. Ein frischer Look und konstruktive Kritik verbessern das Produkt.
- Wir bereiten den Text für den Druck vor. Wir nehmen endgültige Änderungen vor, denken über Illustrationen nach, wählen die geeigneten Hubs aus - und drucken!
Die Reihenfolge dieser Stufen ist nicht streng. Es kommt vor, dass der Autor zuerst einen Plan erstellt, jedes Element aufdeckt und auf die gewünschte Ebene detailliert, und dann den Text in mehreren Iterationen korrigiert. Und es kommt vor, dass der Entwickler zunächst die Lösung für die Arbeitsaufgabe skizziert und bereits auf dieser Basis der Text für Habr geboren ist. Zu jedem Zeitpunkt können sich andere Kollegen dem Artikel anschließen, um mit einer Idee oder einem Rat zu helfen.
Und jetzt von den Plänen zum Handeln. Das heißt, zum Text.
Viele Aufgaben: Wie finde ich Zeit, um am Text zu arbeiten?
Die Arbeit an Texten im Stil „alle Aufgaben abschieben und mit dem Kopf gehen“ funktioniert für uns aufgrund des
Busfaktors nicht . Daher beschäftigen sich die Autoren nach und nach mit dem Artikel im Hintergrund des Restes der Arbeit. Oft ist der Text ein Kompendium der eigentlichen Arbeitsaufgabe.
Einer unserer Autoren verglich diese Arbeit mit Tests. Zuerst denken Sie, dass es keine Zeit gibt, Tests zu schreiben. Dann binden Sie diese Aktivität in den Prozess ein - und es stellt sich heraus, dass Zeit ist. Texte wie Tests helfen zu verstehen, was passiert. Selbst wenn Sie dem Artikel stündlich am Tag etwas zuweisen, funktioniert es. Natürlich, wenn es für eine Person wichtig ist.
Ein anderer schreibt streng morgens. Das erste zuerst. Da er weiß, dass er noch viel zu tun hat, kann er vom Beginn des Arbeitstages an 20 Minuten mit dem Text verbringen. Unter solchen Umständen stellt sich heraus, dass klar, präzise und auf den Fall geschrieben wird.
Ich möchte einen Artikel über Habr schreiben und habe mir sogar ein Thema ausgedacht. Wo soll ich anfangen?
An diesem Problem ist nichts Neues. Stephen King, George Orwell, Edgar Allan Poe, die Strugatsky-Kameraden, das Duett Henry Lyon Oldie, Richard Feynman und viele andere Autoren in der einen oder anderen Form sagten:
"Wenn Sie etwas anfangen möchten (um einen Artikel, ein Buch oder einen Brief an einen Freund zu schreiben), dies aber immer noch nicht können, gibt es keine bessere Zeit und Situation, als ... im Moment!"
Einer von uns hilft dabei, einen Texteditor zu öffnen und sich dort Gedanken über das Thema zu machen. Höchstwahrscheinlich stellt sich dann heraus, dass dies „alles falsch“ ist, aber der erste Schritt wurde getan - die Arbeit an dem Artikel hat begonnen.
Es gibt noch einen anderen Weg: einen anderen Mitarbeiter zu finden und ihn über das Thema des Artikels zu informieren. Und um die Geschichte mit den Worten zu beginnen: "Nun, kurz ...". Und sobald die ersten Gedanken kamen, rief er "Danke!" lauf weg zu dir selbst und schreibe dringend deine Geschichte auf. Mit einfachen Worten, mit Produktionsmatten, die Sie dann durch etwas Konstruktives ersetzen.
Und für einen Snack liegt der Weg vom Klassiker ausschließlich in Ihrer Verantwortung.
Ich schreibe, ich schreibe, ich stecke fest. Was zu tun ist?
Es gibt drei Szenarien, die auf die Situation angewendet werden können:
- Trinken Sie eine Tasse Tee und entspannen Sie sich. Sie müssen sich sicherlich nicht zwingen, wenn der Text "nicht geht" - nichts Gutes kommt von einer solchen Überwindung. Hier geht es übrigens nicht nur um das Schreiben von Artikeln.
Aber einen Job zu werfen ist es nicht wert. Sobald Sie das Gefühl haben, mehr oder weniger entspannt zu sein, lesen Sie noch einmal, was geschrieben steht, und Sie werden sicher an einen anderen Gedanken denken. Zeichnen Sie einen Umriss der Textstruktur. Wirf einen Text an einen Kollegen.
Machen Sie etwas um den Text herum, aber erpressen Sie keine Wörter. Dann schwärmen die Gedanken selbst und es wird nur notwendig sein, sie am Schwanz zu packen - und sie so wie sie ist auf Papier / in einen Texteditor zu schreiben. - Harken Sie das gesamte Material "wie es ist" in die Veröffentlichung des Artikels. An diesem Punkt müssen Sie die Hauptgedanken fertig schreiben oder logisch mit der Schlussfolgerung schließen, dass es sie gibt. Wenn dies gut aussieht, kann der Rest zum nächsten Artikel verschoben werden.
- Eine tiefe und anhaltende Betäubung kann bedeuten, dass das Thema nicht nah ist und Sie nicht darüber schreiben müssen. Solche Themen sollten in der ersten Phase besser abgeschnitten werden. Oder konsultieren Sie einen Kollegen.
Wenn Sie andere Möglichkeiten haben, wie Sie aus einem kreativen Stupor herauskommen können, teilen Sie dies in den Kommentaren mit.
Abschließend
Schreiben Sie. Hören Sie niemandem zu und schreiben Sie. Das ist gut. Und Sie werden gut schreiben - im Allgemeinen ausgezeichnet. Und dann wird die Habro-Community klug, schwört und reich wird.
Zum Schluss nützliche Links zu diesem Thema:
Teilen Sie Ihre Rezepte in den Kommentaren, warten Sie!