Im Vorfeld von einer aktuellen Podcast-Folge mit der unglaublichen technischen Autorin und Chefredakteurin von Smashing Magazine, Rachel Andrew, habe ich viele Gedanken und Referenzen zum Thema technisches Schreiben gesammelt. So viele kluge Leute haben über die Jahre viele kluge Dinge gesagt, dass ich dachte, ich sammle einige meiner Lieblingsratschläge und streue meine eigenen Erfahrungen ein, als jemand, der ebenfalls seinen fairen Anteil an technischem Schreiben und Lektorat geleistet hat.
Es gibt eine viel größere Welt des technischen Schreibens da draußen. Meine Erfahrung und mein Interesse liegen hauptsächlich im Bereich der Webtechnologie und des Bloggens, daher betrachte ich es aus diesem Blickwinkel, und viele der Leute, die ich im Laufe des Textes zitiere, sind in der gleichen Situation.
Etwas zum Schreiben auswählen
Wenn Sie für CSS-Tricks schreiben möchten und mich fragen, worüber Sie schreiben sollen, werde ich diese Frage wahrscheinlich an Sie zurückgeben. Wahrscheinlich kenne ich Sie nicht gut genug, um das perfekte Thema für Sie auszuwählen. Wichtiger ist, dass ich wirklich möchte, dass Sie über etwas schreiben, das für Sie persönlich und wichtig ist. Artikel, die auf jüngster Begeisterung für eine bestimmte Idee oder Technologie basieren, sind immer besser als diktierte Aufgaben.
Mein bester Rat
Schreiben Sie den Artikel, den Sie gerne gefunden hätten, als Sie etwas gegoogelt haben.
— Chris Coyier (@chriscoyier) 30. Oktober 2017
Davon abgesehen pflege ich eine Liste von Ideen speziell für diese Seite. Jedes Schreiben *kann* im Auftrag erfolgen, und manchmal löst dies den Funken aus, der für etwas Großartiges und Passendes für das Publikum einer Seite erforderlich ist.
Schreiben Sie im Moment des Lernens
Der Moment, in dem Sie etwas lernen, ist die beste Zeit zum Schreiben. Es ist frisch in Ihrem Gedächtnis, und Sie können sich erinnern, wie es war, *bevor* Sie es verstanden haben. Sie verstehen auch, was nötig ist, um vom Nichtwissen zum Wissen zu gelangen. Das ist die Reise, auf die Sie die Leute mitnehmen müssen.
Wenn Sie keine Zeit haben, versuchen Sie zumindest, die Stimmung dort einzufangen, wo Sie Ihre Ideen speichern. Schreiben Sie nicht nur "Dataset". Schreiben Sie sich schnelle Notizen wie: "Ich wusste nicht, dass DOM-Elemente eine .dataset-Eigenschaft zum Abrufen und Setzen von Datenattributen haben. Ich frage mich, ob es besser ist, diese zu verwenden als getAttribute." Auf diese Weise können Sie diese Erkenntnis wieder in Ihrem Gehirn laden, wenn Sie die Idee erneut aufgreifen.
Was haben Sie in den *letzten Tagen* gelernt? Ich wette, da gibt es einen Blogbeitrag. Manuel Matuzovic macht hierfür mit dem „Today I Learned“-Bereich (TIL) seines Blogs eine ausgezeichnete Arbeit.
Der Vergleich von Technologien ist ein unterbewertetes Format
Hier ist ein Ratschlag, den Rachel geteilt hat und von dem ich sehe, dass er nicht annähernd genug genutzt wird
Es gibt einen Sweet Spot für das Schreiben von technischen Beiträgen und Tutorials. Schreiben Sie für den Profi, der noch keine Zeit hatte, sich mit diesem Thema zu beschäftigen, und verknüpfen Sie es mit Dingen, die er bereits kennt. Zum Beispiel die Erklärung einer modernen JS-Technik für jemanden, der jQuery kennt.
— Rachel Andrew (@rachelandrew) 20. Februar 2019
Erzählen Sie mir, wie sich dieses *neue* Framework auf Backbone bezieht. Erzählen Sie mir, wie dieses CMS zu WordPress steht. Erzählen Sie mir, wie eine Technologie mit einer anderen Technologie verbunden ist, von der man sicher annehmen kann, dass sie weithin verstanden wird.
Technologie ändert sich viel, aber *was Technologie tut*, ändert sich nicht allzu sehr.
Vorsicht mit der Einleitung
Der wichtigste Kommentar, den ich zu Tutorials, die ich überprüfe, hinzufüge, ist die Bitte um eine Einleitung, die beschreibt, worum es in dem Tutorial geht. Ich bin 600 Wörter weit und weiß immer noch nicht, worum es in dem Tutorial geht und für wen es ist. #writing
— Rachel Andrew (@rachelandrew) 5. Januar 2018
Nicht direkt auf den Punkt zu kommen, ist eine verflixte Epidemie bei technischen Artikeln. Der Anfang eines technischen Artikels ist nicht die Zeit, um poetisch zu schwärmen oder irgendeine klischeehafte leichte Philosophie abzulassen wie "Webdesign hat sich wirklich stark verändert". Sie müssen nicht langweilig sein, aber Sie müssen mir sagen, *worüber* dieser Artikel handeln wird und *für wen* er bestimmt ist.
„Lässt der Titel den Artikel interessant klingen?“ Wenn der Titel einen Leser interessiert, wird er normalerweise die Einleitung lesen und entscheiden: „Lohnt es sich, das Ganze zu lesen?“ Ein häufiger Fehler, den ich bei vielen technischen Beiträgen sehe, ist entweder zu viel Einleitung oder, alternativ, viel zu wenig.
Ein einzelner gut geschriebener Absatz kann die Bühne für einen technischen Blogbeitrag bereiten.
Vorsicht auch mit dem Titel
Ich erinnere mich an ein Gespräch von vor Jahren mit der Content-Strategin Erin Kissane, bei dem sie mir dringend riet, für alles *langweilige* Titel zu wählen. Nicht nur für Blogbeiträge, sondern für alles, einschließlich der Namen von Abschnitten, Tags und sogar Zwischenüberschriften innerhalb von Beiträgen.
Das Ding mit Langeweile: es funktioniert. Langweilig ist auch nicht das richtige Wort; es ist *Klarheit*. Die Welt ist voller Clickbait, und vielleicht ist das in einigen Genres effektiv, aber technisches Bloggen gehört nicht dazu.
Ein schöner klarer Blogtitel: Getting Started with GraphQL, Phoenix, and React von Margaret Williford
Eine schreckliche Version desselben: Bauen Sie in 30 Minuten eine Web-App mit modernen Technologien!
Was ist eine Web-App? Welche Technologien? Was ist an ihnen modern? Was soll diese seltsame Zeitbegrenzung?
SEO ist wichtig, und Margarets Artikel wird mit diesem klaren Titel sowohl kurz- als auch langfristig viel besser abschneiden.
Das Outro
Ben Halpern sagt, dass das Nächstwichtigste nach der Einleitung ist
[...] der letzte Absatz.
Die Leute lesen nicht von oben nach unten, sobald sie ankommen, daher ist die Chance groß, dass es der zweite Absatz ist, den die Leute lesen. Persönlich finde ich den Anfang viel wichtiger als das Ende, aber es gibt auch eine gewisse Kunst im Ende.
Viele Leute schreiben einfach <h2>Fazit</h2> und ein paar Worte darüber, was gerade besprochen wurde. Ehrlich gesagt, hasse ich das nicht. Es fällt in dieses zeitlose Muster
- Sagen Sie ihnen, was Sie ihnen sagen werden
- Sagen Sie es ihnen
- Sagen Sie ihnen, was Sie ihnen gesagt haben
Das hilft Ihrer Botschaft, sich einzuprägen und bringt die Dinge zu einem runden Abschluss. Technisches Bloggen unterscheidet sich in diesem Sinne nicht wesentlich von Marketing. Sie versuchen, die Leute dazu zu bringen, etwas zu verstehen, und Sie nutzen alle Tricks, die Sie brauchen, um die Aufgabe zu erfüllen. Ein wenig Wiederholung ist ein klassischer Trick.
Machen Sie es scanbar
[...] Die Textwand kann durch die Verwendung visueller Elemente, die sie auflockern, leicht weniger einschüchternd und viel ansprechender gestaltet werden. Am einfachsten ist es, einfach Abschnittsüberschriften in Ihrem Beitrag zu verwenden.
Ich stimme zu: Unterüberschriften sind wahrscheinlich der einfachste und wirkungsvollste Trick für die Scanbarkeit.
Andere Methoden
- Listen: So wie ich es gerade mache! Ich musste keine Liste verwenden. Absätze hätten auch funktioniert, aber eine Liste ist hier kontextbezogen sinnvoll und verleitet wahrscheinlich einige von Ihnen dazu, dies zu lesen. Oder zumindest zu scannen und dabei einige Kernpunkte zu erfassen.
- Bilder: Bitte machen Sie sie relevant und kontextbezogen. Überspringen Sie die lustige GIF. Screenshots sind in einem technischen Kontext oft großartig, da sie eine visuelle Darstellung dessen bieten, was sonst ein schwer zu erklärender Begriff sein könnte. Ich mag auch Unsplash für thematische Bilder, aber Sie können Besseres finden als ein zufälliges Bild von Bäumen, einer Frau, die Kaffee trinkt, oder einem zufälligen Serverrack.
- Illustrationen: Die abstrakte Natur einer Illustration ist Ihr Freund. Sie verleitet die Leute zu einem schnellen Gedanken über das, was Sie beschreiben. Sie erfordern normalerweise etwas Arbeit, aber der Erfolg für Sie und den Leser kann riesig sein.
- Videos: Sie können nicht einfach ein 42-minütiges Video mitten in einen Blogbeitrag einfügen, aber wenn Sie deutlich machen können, dass Sie etwas Visuelles demonstrieren und das Video kürzer als eine Minute ist, kann dies eine wirkungsvolle Wahl sein. Sie haben immer
<video autoplay muted loop controls>zur Verfügung, um es GIF-ähnlich zu machen. - Codeblöcke: Technische Blogbeiträge handeln oft von Code. Vermeiden Sie Code nicht, nehmen Sie ihn an. Ich liebe, wie Dan Abramov Codeblöcke in Blogbeiträge einstreut, nicht so sehr, um Syntax und Einrichtung zu demonstrieren, sondern um Punkte zu machen. Ich empfehle auch Embedded Pens, da sie vollständige interaktive Demos sind und zusätzlich als Codeblöcke dienen.
- Tabellen: Vergessen Sie tabellarische Daten nicht! Die Darstellung von Informationen (insbesondere Daten oder Definitionen) in einer Tabelle macht sie verständlicher, als sie es auf irgendeine andere Weise gewesen wäre.
- Kollabierbare Abschnitte: Die Elemente
<details>/<summary>erledigen schnelle Arbeit bei kollabierbaren Inhalten. Wenn Sie einen großen Inhaltsabschnitt haben, der gut platziert ist, aber nicht von jedem gelesen werden muss, klappen Sie ihn ein! Unsere Referenzanleitung für Media Queries für Geräte ist ein gutes Beispiel dafür.
Was auch immer Sie hier wählen, Sie sollten Dinge wählen, die helfen, die von Ihnen aufgestellten Punkte zu verbessern, auch wenn es sich in gewisser Weise wie Trickerei anfühlt. Es ist Trickerei, um die Lesbarkeit zu verbessern, und das ist eine gute Sache.
Meine Lieblingstechnik? Ein wenig Design. Verwenden Sie Designprinzipien wie Abstände, Farben und Ausrichtung, um die Lesbarkeit von Beiträgen zu verbessern. Wir gehen sogar so weit, einige Beiträge künstlerisch zu gestalten, bei denen Design den zentralen Punkt verbessern kann.
Hier geht es nicht darum, Textwände ganz abzuschaffen. Manchmal ist genau das nötig, weil Sie einen Leser bitten, eine Passage tiefgehend zu lesen, die er sonst nicht verstehen würde. Aber häufiger kann ein Beitrag von einer gesunden Nutzung von Weißraum stark profitieren.
Verwenden Sie eine aktive Stimme
Ich finde diesen Punkt etwas knifflig zu begreifen, aber Katy Decorah hat eine großartige Präsentation über technisches Schreiben, die diesen Punkt sehr detailliert erklärt. Es ist so etwas wie die Verwendung des *Präsens* und die direkte Aussage eines Punktes anstatt passiv.
Passiv: „Nachdem die Datei heruntergeladen wurde…“
Aktiv: „Nachdem Sie die Datei heruntergeladen haben…“
Passiv: „Die Anfrage wird vom Server verarbeitet.“
Aktiv: „Der Server verarbeitet die Anfrage.“
Hier ist eine weitere klare Erklärung mit Beispielen von Neal Whitman, gelesen von Mignon Fogarty (Grammar Girl)
Es gibt viele Wörter zu vermeiden
„Nur“ ist ein großes Problem. Brad Frost
„Nur“ gibt mir das Gefühl, ein Idiot zu sein. „Nur“ setzt voraus, dass ich aus einem bestimmten Hintergrund stamme, bestimmte Kurse an der Universität belegt habe, fließend in bestimmten Technologien bin und alle richtigen Bücher, Artikel und Ressourcen gelesen habe. „Nur“ ist ein gefährliches Wort.
Es gibt viele andere zu vermeiden, über die ich bereits geschrieben habe. Lesen Sie die Kommentare im letzten Link. Lange Rede, kurzer Sinn: Es gibt viele Wörter, die im technischen Schreiben mehr Schaden als Nutzen anrichten, nicht nur, weil sie belehrend wirken können, sondern weil sie die Sätze, in denen sie verwendet werden, *normalerweise* nicht verbessern. Versuchen Sie, „nur“ aus einem Satz zu entfernen. Der Satz wird auch ohne ihn Sinn ergeben.
Achten Sie auf Ihren Tonfall
Tonfall bezieht sich darauf, wie Sie etwas unter Berücksichtigung des Kontexts sagen. Sie würden zum Beispiel keine schlechten Nachrichten mit einem fröhlichen Tonfall überbringen. Die Art und Weise, wie Sie sich ausdrücken, sollte mit der Situation übereinstimmen.
Das ist unser Tonziel auf dieser Seite
Freundlich. Autorativ. Einladend. Wir stecken alle zusammen in diesem Boot. Flexibel (nicht dogmatisch bei Ideen). Dankbar.
MailChimp hat eine sehr umfangreiche Anleitung zu ihren.
Es ist erwähnenswert, dass Tonfall und Stimme separate Konzepte sind. Ich denke gerne an Stimme als etwas, das sich nie ändert (es ist Ihre Persönlichkeit, die Teil dessen ist, wer Sie sind), während sich der Tonfall je nach Kontext ändert. Mit anderen Worten, Sie können eine professionelle Stimme haben und gleichzeitig einen freundlichen Ton anschlagen.
Ich glaube nicht, dass es *einen einzigen wahren* Tonfall gibt, der für technisches Schreiben perfekt ist, aber da das übergeordnete Ziel jedes technischen Schreibens darin besteht, jemandem zu helfen, etwas Kompliziertes zu verstehen, können Sie den Tonfall nutzen, um zu helfen. Ein Witz mitten in einer Reihe komplizierter Schritte ist verwirrend. Viel! Aufregung! über etwas könnte fehl am Platz oder unehrlich wirken, aber trocken und leblos zu sein ist schlimmer. Ich würde sagen, wenn Sie unter Ihrem eigenen Namen schreiben, lassen Sie ein wenig Ihrer Persönlichkeit durchscheinen, solange es nicht auf Kosten der Klarheit geht. Wenn Sie unter einer Marke schreiben, passen Sie sich an das an, was sie etabliert hat, ob kodifiziert oder nicht.
Vorsicht bei der Länge
Die allgemeine Tendenz im technischen Schreiben ist, *zu viel* statt zu wenig zu schreiben. Wade Christensen
Ob durch Schulaufgaben mit Wortminimum-Vorgaben oder einfach unkritisch geschult, die meisten von uns schreiben zu viel. Neben der Herangehensweise an jeden Entwurf mit einer rücksichtslosen Kürzung gibt es mehrere Möglichkeiten, von Anfang an kurz zu schreiben.
Wortbegrenzungen können helfen, auch wenn sie selbst auferlegt sind.
Ich hörte kürzlich von einem angehenden Redakteur, der damit zu kämpfen hatte, dass seine Autoren Beiträge mit hoher Wortzahl einreichten, also schlug er vor, sie als Richtlinie bei 1000-1500 zu halten, und das schien effektiv zu sein. Dieser Beitrag ist ungefähr doppelt so lang wie das obere Ende zum Vergleich.
Die wirkliche Lösung, wenn die Ressourcen vorhanden sind, ist eine rücksichtslose Bearbeitung.
Ich persönlich finde nicht, dass zu lange zu schreiben das einzige Problem ist. Ich hatte genauso viele Fälle, in denen Autoren zu kurz schrieben und das Thema nicht tief genug behandelten. Ich konzentriere mich nicht gerne auf die Länge; ich konzentriere mich auf die Klarheit der Vermittlung und die Nützlichkeit des Inhalts selbst.
Nebenbemerkung: Das Aufteilen eines Beitrags in mehrere Teile (als separate Beiträge einer Serie) ist keine Lösung für zu lange Beiträge. Tatsächlich kann es das Problem verschärfen. Tun Sie dies nur, wenn die verschiedenen Teile thematisch unterschiedlich sind und für sich allein stehen können.
Halten Sie sich nicht vom Schreiben ab
Es gibt eine unsichtbare Kraft, die aus Angst aufgebaut ist und viele Leute vom technischen Bloggen fernhält. „Ach, das weiß doch jeder schon“, denken Sie vielleicht. (Das tun sie nicht). „Was, wenn ich falsch liege und mich jemand darauf anspricht?“ (Sie liegen nicht falsch, wenn das, was Sie tun, für Sie funktioniert.)
Es kann immer noch Blockaden geben, selbst wenn Sie diese Ängste überwinden und beginnen, Worte auf den Bildschirm zu bringen. Hier ist Max Böck
Während des Schreibens passiert mir etwas. Ich beginne mit einer frischen Idee, begeistert, sie in Worte zu fassen. Aber mit der Zeit verliere ich das Selbstvertrauen.
Der Trick für Max ist, nicht zu lange zu warten und Gefühle zu ignorieren, die einen zurückhalten
Ich werde etwas veröffentlichen, sobald ich zuversichtlich bin, dass alle wichtigen Punkte, die ich vermitteln möchte, enthalten sind. Ich versuche, die Stimme zu ignorieren, die schreit „es ist noch nicht fertig“, gerade lange genug, um es online zu stellen.
Jeremy Keith geht sogar so weit zu sagen, dass wir nicht einmal Entwürfe aufbewahren sollten
Ich denke, das Aufbewahren von Entwürfen kann kontraproduktiv sein. Das Problem ist, dass etwas, sobald es ein Entwurf und kein Blogbeitrag mehr ist, wahrscheinlich ein Entwurf bleibt und nie zu einem Blogbeitrag wird. Und je länger etwas im Entwurf bleibt, desto unwahrscheinlicher ist es, dass es jemals ans Licht kommt.
Die Chancen, dass Ihr Schreiben jemandem hilft, sind ziemlich hoch! Matthias Ott:
Selbst der kleinste Beitrag kann jemandem da draußen helfen.
Denken Sie, Sie sind zu unerfahren? Wahrscheinlich nicht, aber selbst wenn Sie es wären, ist die Perspektive von jemandem mit weniger Erfahrung immer noch nützlich. Ali Spittel
Wenn Sie einen Blogbeitrag haben, der hauptsächlich korrekte Informationen enthält, oder zumindest Ihre Interpretation des Themas, dann sind Sie erfahren genug. Es gibt viele ausgezeichnete Beiträge aus der Perspektive von Neulingen, und sie sind wirklich wichtig!
Angst ist beim Schreiben ein echtes Problem, und der Umgang damit kann lähmend sein. Obwohl es sich hauptsächlich an kreatives Schreiben richtet, ist The War of Art von Stephen Pressfield eine gute Lektüre, um die Angst zu überwinden.
Es gibt keinen perfekten Stil
Jeder von uns hat seine eigenen einzigartigen Perspektiven und Schreibstile. Ein Schreibstil mag für einige zugänglicher sein und kann daher eine große (oder sogar kleine) Anzahl von Menschen auf unerwartete Weise unterstützen und fördern.
…sagt Sara Soueidan. Sie fährt fort
Schreiben Sie einfach.
Auch wenn nur eine Person etwas aus Ihrem Artikel lernt, werden Sie sich großartig fühlen und dazu beigetragen haben – und sei es nur ein kleines bisschen – zu dieser erstaunlichen Gemeinschaft, aus der wir alle ständig lernen.
Technische Blogbeiträge müssen nicht kreativitätsfrei sein. Sie könnten einen wunderbaren technischen Blogbeitrag erstellen, der ein kommentiertes Chatroom-Gespräch zwischen zwei Entwicklern ist, die voneinander lernen. Oder einen Blogbeitrag, der eine Reihe von Videos ist, die aufeinander aufbauen.
Je einführender, desto höher die Messlatte
Das Web ist gesättigt mit anfängerfreundlichen und oberflächlichen Blogbeiträgen. Es gibt ein Meer von Crashkursen, 101ern und Einführungen da draußen. Sie müssen es aus dem Park schlagen, wenn Sie auffallen und nützlich sein wollen.
Es gibt keine besondere Tonänderung für einen anfängerorientierten Beitrag. Sie müssen nicht das Äquivalent von langsamem Sprechen oder Herunterreden tun. Sie müssen nur klar sein, und Klarheit ist für Leser auf jedem Fähigkeitsniveau wertvoll, ganz zu schweigen davon, dass sie sie schätzen. Ein sehr fortgeschrittener Programmierer kann die Klarheit in einem technischen Blogbeitrag schätzen, selbst wenn es sich um etwas handelt, das er bereits versteht.
Aber die Messlatte ist im Allgemeinen nicht so hoch
Sie brauchen kein jahrzehntelanges Erlebnis, um einen Blogbeitrag zu schreiben. Ich würde sagen, es ist eher ein Tag Erfahrung, der Wunsch zu schreiben und etwas zu sagen zu haben. Ich denke, Sie wären überrascht, wie wenig Sie tun müssen, damit ein Blogbeitrag hervorsticht und gelesen wird. Stecken Sie etwas Mühe hinein, machen Sie klare Aussagen, konzentrieren Sie sich auf die Lesbarkeit, und Sie werden gut abschneiden.
Ich hoffe, die Ratschläge in diesem Beitrag helfen!
Abstraktion ist hilfreich, aber Beispiele aus der realen Welt sind manchmal besser
Es ist eine Sache, ein übergeordnetes Konzept zu beschreiben, und eine andere, zu erklären oder zu veranschaulichen, wie dieses Konzept in der realen Welt angewendet wird. In der technischen Dokumentation werden Sie oft komplexe oder schwer verständliche Themen behandeln, daher ist es umso wichtiger, ein oder zwei gut platzierte Beispiele zu verwenden, um zu zeigen, warum Ihr Thema wichtig ist oder wie es sich auf die reale Welt bezieht.
Ich neige dazu, Code, der zu abstrakt ist, stärker abzulehnen als Code, der zu sehr auf einen realen Anwendungsfall fokussiert ist. Ich sehe lieber ["Charles Adok", "Samantha Frederick"] als ["foo", "bar"] oder [a, b] jederzeit, aber noch wichtiger ist, was dann mit diesen Daten gemacht wird, damit sie sich wie ein nachvollziehbares Programmierszenario anfühlen.
Aber vermeiden Sie Beispiele aus der realen Welt, die auf Kosten der Klarheit gehen. Wenn Abstraktion nützlich ist, um einen komplexen Punkt zu verdeutlichen, ohne sich in Details zu verlieren, dann sei es so.
Bloggen öffnet Türen
Jeder, den ich je getroffen habe und der jemals aktiv gebloggt hat, hat gesagt, dass das Bloggen einen positiven Einfluss auf seine Karriere hatte. Abgesehen davon, dass es eine öffentliche Demonstration Ihrer Fähigkeit ist, Ideen zu durchdenken und zu präsentieren, hilft es *Ihnen*, Dinge besser zu verstehen. Lehren heißt lernen.
Ich schreibe meinen eigenen Bloggerfolg dem Schreiben zu. Hier ist Khoi Vinh, ein Designer, der zehnmal erfolgreicher ist, als ich es jemals sein werde
Es ist schwer zu überschätzen, wie wichtig mein Blog war, aber wenn ich es auf ein Wort reduzieren müsste, wäre es: „Verstärker.“
Man wird besser in dem, was man tut.
Es gibt keinen Weg daran vorbei: Übung macht besser. Die Erwartungen an Übung sind manchmal sehr klar und kulturell verankert. Um besser Klavier spielen zu können, nimmt man Klavierunterricht und übt. Das wissen wir alle. Aber Leute sagen auch „Oh, ich bin ein schrecklicher Koch“, als ob Kochen als Fähigkeit irgendwie grundlegend anders wäre als Klavierspielen und nicht dieselbe Lern- und Übungszeit erfordern würde.
Man wird besser im Schreiben, indem man mehr schreibt. Das heißt, *mit Einsatz schreiben*. Schreiben und dann öffentlich veröffentlichen, was man schreibt, sodass Leute es lesen.
Man kann auf eine Schreibschule gehen. Man könnte sich einen Schreibcoach suchen. Mein Gedanke ist, nichts lehrt besser als häufiges Schreiben. Worauf man auch immer Zeit verwendet, darin wird man gut. Sind 10.000 Stunden ein gutes Rahmenwerk für Sie? Dann nutzen Sie es. Selbst Leute, die viel fernsehen, werden am Ende ziemlich gut darin, fernzusehen.
Ihre Stimme allein < Eine Geschichte mit Kontext < Geschichten, die andere einbeziehen < Forschung und Daten zusammen mit Geschichten, die andere einbeziehen
Ein Artikel, in dem Sie nur etwas sagen, ist in Ordnung. Sie dürfen etwas sagen.
Aber Sie können es besser machen.
Ein Artikel, in dem Sie eine wahre Geschichte darüber erzählen, wie etwas für Sie funktioniert hat, ist besser. Kontext! Jetzt können wir besser verstehen, woher Sie kommen, wenn Sie Ihre Meinung sagen. Außerdem mag jeder eine Geschichte.
Ein Artikel, in dem Sie das mit Zitaten aus den Schriften und Geschichten *anderer* Leute kombinieren, ist noch besser. Jetzt malen Sie ein größeres Bild und helfen, das, was Sie sagen, zu validieren. Kontext *und* Würze!
Ein Artikel, in dem Sie all das mit Forschung und Daten kombinieren, ist der beste. Jetzt sind Sie persönlich, erkennen eine Welt außerhalb von sich selbst an, fügen Kontext hinzu und vermeiden, zu anekdotisch zu sein. Kapow! Jetzt schreiben Sie!
Pitcht du?
Lesen Sie, was die Seite über Gastbeiträge sagt. Hier ist unsere.
Ich will Sie nicht abschrecken, aber 90% der Einreichungen sind Müll. Vielleicht sind 75% reiner Spam und weitere 15% sind Leute, die eindeutig nichts von dem gelesen haben, was wir über Gastbeiträge gesagt haben und weit daneben liegen. Ich kann normalerweise allein *an der Qualität des Schreibens in der E-Mail selbst* erkennen, ob sie gute Gastblogger sein werden.
Ich sage solche Dinge und fühle mich dann gezwungen, Sie daran zu erinnern, dass die Messlatte nicht so hoch liegt.
Gibt es nützliche Werkzeuge?
Wahrscheinlich gibt es das, aber ich möchte Sie nicht auf Werkzeuge verweisen, die ich nicht empfehlen kann. Alles, was ich benutze, ist Dropbox Paper für kollaboratives Schreiben, da das Sharing-Modell einfach ist und Ko-Bearbeitung und Kommentare ermöglicht. Dazu Grammarly, weil es eine Menge Fehler abfängt, während Sie tippen.
Ich benutze ein kostenloses WordPress.com-Konto für meinen Blog. Ich hatte Probleme mit Code-Blöcken darauf. Ich habe sowohl Gists als auch CodePen-Embeds verwendet. Beide scheinen gut zu funktionieren. Ich habe mich noch nicht endgültig für einen entschieden. Wichtig ist, dass beide auf WordPress.com-Seiten gut funktionieren.
Wir brauchen mehr Beiträge wie diesen.
Obwohl ich seit einigen Jahren schreibe, mache ich immer noch Anfängerfehler.
Ich denke, jeder, der jemals versucht hat, einen technischen Beitrag (oder sogar Dokumentation) zu schreiben, konnte sich mit den meisten Punkten dieses Artikels identifizieren.
Danke, dass Sie das geteilt haben. Viele hilfreiche Punkte wurden geteilt und ich habe so viele Bereiche, in denen ich mich verbessern kann.
Toller Artikel. In den meisten Fällen benutze ich auch zu viele technische Beschreibungen. Warum? Nun, ich bin Techniker. Also konzentrieren Sie sich darauf, einfache Texte zu schreiben! Danke.
Ich lerne wirklich viel aus diesem Artikel für die Zukunft. Es ist mein Traum, das technische Wissen, das ich habe, zu lernen und zu teilen, und das schon seit 8 Jahren. Manchmal schlagen einen die Lebensumstände von seinen Ambitionen ab. Und das ist ein guter Motivator und entfacht die Hoffnung neu und erneuert meinen Drang, meine wahre Leidenschaft zu verfolgen. **Tolle Ratschläge für technisches Schreiben**.
Bitte verwenden Sie keine automatisch ablaufenden Animationen. Das löst bei manchen von uns Migräne aus.
Interessanter Artikel! Das wird mir sehr helfen! Danke!