Ein Styleguide zum Schreiben auf Medium

Nachdem ich mehr als 1.000 Stunden damit verbracht habe, Geschichten für unsere Medium-Veröffentlichung zu schreiben und zu bearbeiten, habe ich beschlossen, diesen Lebensstil-Leitfaden für Mitwirkende zu erstellen. Sie können es auch für Ihre Publikation verwenden.

Schlagzeilen

Dies ist der wichtigste Teil Ihrer Geschichte, und Sie sollten sich ernsthafte Gedanken darüber machen.

Verwenden Sie keinen Clickbait:

"Du wirst dieses lächerlich effektive dunkle Überschriftenmuster nicht glauben."

Verwenden Sie keine Listenfelder:

"11 empörende Schlagzeilen, die die Leute dazu zwingen werden, Ihre mittlere Geschichte zu lesen"

Sag die Wahrheit:

„Clevere, aber sachliche Überschrift zu einem interessanten Thema“

Kennzeichnen Sie Geschichten, die Teil 1 einer Serie sind, nicht als „Teil 1.“. Dies macht den Leuten Angst, da sie das Lesen als größeren Zeitaufwand empfinden. Und wer weiß, wann Sie zum Schreiben von Teil 2 kommen.

Wenn Ihre Überschrift zu lang ist, wird sie von Mittel abgeschnitten. Lange Überschriften können auch verhindern, dass Ihr Top-Bild in Newsfeeds angezeigt wird.

Bilder

Medium bietet vier verschiedene Bildbreiten. Beachten Sie, dass diese auf Mobilgeräten alle gleich aussehen.

Meistens möchten Sie die Spaltenbreite beibehalten:

Wenn Sie ein Diagramm haben, das im Kleinen schwer zu lesen ist, vergrößern Sie es:

Und wenn Sie wirklich stolz auf ein Bild sind oder es voller interessanter Daten steckt, gehen Sie auf Hochtouren:

... und dann ist da noch die Seite. Verwenden Sie diese Größe überhaupt nicht, da dies die Lesbarkeit des Texts beeinträchtigt.

Es ist auch unangenehm, wenn Sie mit dem Sprechen über das Foto fertig sind und Ihr Text immer noch zur Seite geschoben wird.

Ja. Ich stecke immer noch hier fest.

Fügen Sie immer ein hochauflösendes Bild am Anfang einer Geschichte unter Ihrer Überschrift ein. Dies hat folgende Vorteile:

  1. Wenn Leute Ihre Geschichte auf Facebook und Twitter teilen, wird sie in Newsfeeds stärker hervorgehoben, sodass die Wahrscheinlichkeit steigt, dass Leute darauf klicken.
  2. In den eigenen Newsfeeds von Medium wird es besser aussehen.
  3. Menschen sind visuelle Wesen und klicken auf Bilder.

Zuschreibung

Technisch gesehen haften Sie als Autor für Urheberrechtsverletzungen und Medium nicht. Die einfachste Möglichkeit, ein Bild zuzuordnen, besteht darin, die Wörter „Bildgutschrift“ unter ein Bild zu setzen und diesen Text mit seiner ursprünglichen Quelle zu verknüpfen.

In einigen Fällen ist dies für einen Inhaber von Bildrechten möglicherweise nicht ausreichend. In der Praxis haben die meisten Magazine und Filmstudios jedoch besseres zu tun, als denjenigen, die lediglich ihre urheberrechtlich geschützten Bilder zugeschrieben haben, Unterlassungserklärungen zuzusenden.

Wenn Sie nach Bildern suchen, die Sie ohne Erlaubnis sicher verwenden können, durchsuchen Sie Pexels, Unsplash oder Google nach Bildern, die als wiederverwendbar gekennzeichnet sind.

Eine Google-Bildsuchabfrage mit der Option

Plagiate - die falsche Darstellung des Schreibens eines anderen als Ihres eigenen - sind im College ein schwerwiegendes Vergehen, und es ist bei Medium genauso schwerwiegend. Zitieren Sie immer die Personen, die sie ursprünglich ausgesprochen haben. Wenn es sich um ein mehrzeiliges Zitat handelt, sollten Sie die Pull-Anführungszeichen von Medium verwenden:

"Wenn Sie Ihren eigenen Witz haben, ist es ein Vergnügen, anderen Menschen die Ehre zu erweisen."
- Criss Jami

Beachten Sie, dass Sie unter keinen Umständen Pull-Anführungszeichen verwenden sollten, da dies die Lesbarkeit des Texts erschwert. Widerstehen Sie der Versuchung, Zitate zu verwenden, um Ihre eigene Geschichte zu zitieren, oder etwas zu ärgern, das Sie sowieso sagen möchten. Dies ist eine Selbstverherrlichung und verschwendet die Zeit Ihrer Leser.

Code

Nach Möglichkeit sollte der Code eher in Textform als in Bildern vorliegen. Dies macht den Code für Screenreader zugänglicher und erleichtert das Kopieren und Einfügen. So können Sie dies tun:

Links

Finde einen Weg, um einen Link in einen Satz zu verwandeln. Wenn ein Link für eine Story von entscheidender Bedeutung ist, setzen Sie ihn in eine eigene Zeile und drücken Sie die Eingabetaste. Dadurch wird eine Vorschau-Karte wie folgt erstellt:

Das Unterstreichen von Text erschwert das Lesen. Verknüpfen Sie daher nur einige Wörter.

Fügen Sie URLs nicht direkt wie folgt ein: http://www.example.com

Verwenden Sie ihre Top-Level-Domains, wenn sie Teil ihrer Marke sind, wie z. B. art.com.

Medien einbetten

Sie können Tweets, YouTube-Videos und andere Medien einbetten, indem Sie deren URLs in einer neuen Zeile in Medium einfügen und dann die Eingabetaste drücken.

Gehen Sie sparsam damit um, da sie Ihren Leser möglicherweise davon abhalten, Ihre Geschichte zu beenden.

Akronyme

Verwenden Sie kein Akronym, es sei denn, das Akronym wird allgemeiner verstanden als es bedeutet. Beispielsweise ist HTTP allgemeiner anerkannt als das Hypertext Transfer Protocol.

Wenn ein Akronym noch nicht allgemein verstanden wird und Sie mehrmals darauf verweisen, können Sie es folgendermaßen als Akronym definieren:

"Zerlegen wir den Code in einen abstrakten Syntaxbaum (AST)."

Hier habe ich aus Gründen der Benutzerfreundlichkeit auch auf den Wikipedia-Artikel verlinkt. Gehen Sie jedoch nicht davon aus, dass Personen diese externen Links lesen. Sie müssen noch Konzepte definieren oder anhand von Beispielen veranschaulichen.

Vermeiden Sie die Definition eines Akronyms in den ersten Absätzen, da dies den Leser verlangsamt und die Wahrscheinlichkeit verringert, dass er mit dem Lesen fortfährt.

Im Folgenden finden Sie eine kurze Liste der Technologie-Akronyme, die Sie nicht definieren müssen: API, AJAX, BIOS, CPU, CSS, HTML, HTTPS, LAN, RAM, REST, USB, WWW, XML. Für alles andere sollten Sie es formulieren.

Buchstabiere immer kurze mehrteilige Wörter wie JavaScript und Frontend. Verkürzen Sie sie nicht - die Kürze ist die mögliche Verwirrung nicht wert.

Textformatierung

Sie können fett oder kursiv - niemals beides - verwenden, um einige Wörter hervorzuheben. Diese verlangsamen den Lesevorgang und sollten sparsam eingesetzt werden. Verwenden Sie für Links weder Fett noch Kursiv. Diese zeichnen sich bereits durch die Unterstreichung aus.

Verwenden Sie keine Verschlusskappen. Sie sehen in alten Büchern elegant aus, aber im Web albern.

Einige altehrwürdige Dropcaps

Wenn Sie etwas hervorheben möchten, verwenden Sie Fettdruck. Kursivschrift ist schwerer zu lesen. Keine fetten Hyperlinks - die Zeile darunter bietet bereits genügend Hervorhebung.

Verwenden Sie nur ein Ausrufezeichen, normalerweise nur nach Ausrufen wie: Golly gee! Hotdog!

Setzen Sie Kommas und Punkte in Anführungszeichen, es sei denn, dies könnte den Leser verwirren (z. B. bei Variablennamen oder Buchtiteln).

In einigen Teilen der Welt werden Leerzeichen vor Doppelpunkte gesetzt. Beispiel. Tu das nicht.

Verwenden Sie Englisch anstelle von Latein:

  • Verwenden Sie "zum Beispiel" anstelle von "E.G."
  • Verwenden Sie "das ist" anstelle von "I.E."
  • Verwenden Sie "note that" anstelle von "N.B."
  • Anstatt Listen mit "etc." zu beenden, beginnen Sie sie mit "like": "Elvis aß Essen wie Brot, Erdnussbutter und Bananen."

Laut Google Books sind Semikolons einem langsamen Tod zum Opfer gefallen. Lassen Sie uns sie aus ihrem Elend befreien. Verwenden Sie stattdessen einfach einen Punkt und teilen Sie die Klauseln in separate Sätze.

Verwenden Sie nach Möglichkeit das Oxford-Komma. Dies macht das Lesen einfacher, klarer und schöner.

Stil

Nutzen Sie die Hemingway App. Dieses einfache Tool hat nichts Magisches an sich, erkennt jedoch automatisch weitgehend abgestimmte Stilprobleme:

  • passive Stimme
  • unnötige Adverbien
  • Wörter, die häufigere Entsprechungen haben

Die Hemingway-App weist Ihrem Schreiben eine „Klassenstufe“ zu. Sogar technische Geschichten können eine Note von 6 erreichen. Und sie sollten danach streben.

Die meisten Menschen sprechen kein Englisch als Muttersprache und diejenigen, die normalerweise nicht den ganzen Tag mit dem Lesen von Chaucer beschäftigt sind. Sie möchten, dass ihre Informationen zugänglich und auf den Punkt gebracht werden.

Err auf der Seite, lange Sätze und Absätze in kürzere zu zerlegen.

Verwenden Sie Kontraktionen. Sie lassen Ihre Prosa gesprächiger erscheinen. Das ist immer ein Plus.

Halte deine Anspannung durchgehend konstant. Wenn Sie über etwas sprechen, das in der Vergangenheit passiert ist, verwenden Sie die Vergangenheitsform.

Verweisen Sie auf Ihren Leser als "Sie" - nicht "wir" oder "uns". "Wir" werden dieses Tutorial nicht ausführen, Ihr Leser wird Ihr Tutorial lesen und es selbst ausführen.

Die Front-End-Entwicklung (Adjektivform mit einem Bindestrich) erfolgt auch, wenn Sie am Front-End (Substantivform ohne Bindestrich) arbeiten. Gleiches gilt für das Backend, den Full Stack und viele andere zusammengesetzte Begriffe.

Abschließender Rat

Denken Sie daran, dass Sie beim Veröffentlichen auf Medium Tausende von Menschen auffordern, Ihnen einige Minuten ihres Lebens zu schenken. Halten Sie Ihre Leser nicht für selbstverständlich.

Bevor Sie eine Geschichte veröffentlichen, empfehle ich Ihnen, zu schlafen, aufzuwachen und sie noch einmal durchzulesen.

Wenn Sie nicht Englisch als Muttersprache sprechen und in Englisch schreiben, bitten Sie einen Muttersprachler, Ihre Geschichte vor dem Einreichen bei einer Veröffentlichung Korrektur zu lesen.

Wenn Sie Ihre Geschichte bei einer Veröffentlichung einreichen, sollten Sie erwarten, dass die Redakteure sie tatsächlich bearbeiten. Denken Sie daran, dass diese Leute viel mehr Zeit damit verbringen, Geschichten zu bearbeiten als Sie und ein besseres Gespür dafür haben, was funktioniert. Lassen Sie sich jedoch nicht davon abhalten, Fragen zu stellen und eventuelle sachliche Ungenauigkeiten zu korrigieren.

Seien Sie vorsichtig bei Veröffentlichungen, die Ihre Geschichte veröffentlichen, ohne Änderungen vorzunehmen. Wenn sie sich nicht die Mühe gemacht haben, es zu bearbeiten (oder sogar zu lesen?), Werden sie sich wahrscheinlich auch nicht viel Mühe geben, es zu veröffentlichen.

Oh, und öffnen Sie Ihre Geschichte nicht mit "Dies wurde in meinem Blog veröffentlicht unter" oder "Update: Dies wurde in Hacker News veröffentlicht". Wenn Sie sich dafür entscheiden, Notizen wie diese hinzuzufügen, setzen Sie sie ganz unten in Ihre Geschichte . Die Leute haben sich nicht durch Ihre Geschichte geklickt, um sofort weggeschickt zu werden - sie haben Ihre Geschichte gelesen.

Eine letzte Sache: Wenn Sie eine Geschichte an die Medium-Veröffentlichung von Free Code Camp senden möchten, senden Sie eine E-Mail an freecodecamp com und erwähnen Sie Bananen in Ihrer E-Mail.

Wenn Sie mehr über effektives Schreiben auf Medium erfahren möchten, lesen Sie Folgendes:

Ich schreibe nur über Programmierung und Technologie. Wenn Sie mir auf Twitter folgen, werde ich Ihre Zeit nicht verschwenden.