Ein Styleguide zum Schreiben auf Medium

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

Schlagzeilen

Dies ist der wichtigste Teil Ihrer Geschichte, und Sie sollten ernsthaft darüber nachdenken.

Verwenden Sie keinen Clickbait:

"Sie werden nicht glauben, dass dieses eine lächerlich effektive dunkle Überschriftenmuster"

Verwenden Sie keine Listen:

"11 unverschämte Schlagzeilen, die die Leute dazu zwingen, Ihre Medium-Geschichte zu lesen"

Sag die Wahrheit:

"Clevere, aber sachliche Überschrift zu einem interessanten Thema"

Beschriften Sie Geschichten, die Teil 1 einer Serie sind, nicht als „Teil 1“. Es schreckt die Leute ab, da sie das Lesen als größeren Zeitaufwand empfinden. Und wer weiß schon, wann Sie Teil 2 schreiben werden.

Wenn Ihre Überschrift zu lang ist, wird sie von Medium 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 sollten Sie sich an die Spaltenbreite halten:

Wenn Sie ein Diagramm haben, das schwer zu lesen ist, wenn es klein ist, gehen Sie größer:

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

… Und dann ist da noch die Seitenspreizung. Verwenden Sie diese Größe überhaupt nicht, da der Text dadurch weniger angenehm zu lesen ist.

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 unter Ihrer Überschrift immer ein hochauflösendes Bild oben in eine Geschichte ein. Dies hat folgende Vorteile:

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

Namensnennung

Die einfachste Möglichkeit, ein Bild zuzuordnen, besteht darin, die Wörter „Bildnachweis“ unter ein Bild zu setzen und diesen Text mit seiner ursprünglichen Quelle zu verknüpfen.

In einigen Fällen reicht dies für einen Bildrechtsinhaber möglicherweise nicht aus. In der Praxis haben die meisten Magazine und Filmstudios jedoch bessere Möglichkeiten, als Unterlassungserklärungen an Personen zu senden, die lediglich ihre urheberrechtlich geschützten Bilder zugeschrieben haben.

Wenn Sie nach Bildern suchen, die Sie ohne Erlaubnis sicher verwenden können, überprüfen Sie Pexels, Unsplash oder durchsuchen Sie Google nach Bildern, die zur Wiederverwendung gekennzeichnet sind.

Plagiate - die falsche Darstellung des Schreibens eines anderen als Ihres eigenen - sind im College eine schwerwiegende Straftat und auf Medium genauso schwerwiegend. Schreiben Sie den Personen, die sie ursprünglich gesagt haben, immer Zitate zu. 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 eine Freude, andere Menschen für ihren zu würdigen."

- Criss Jami

Beachten Sie, dass Sie unter keinen anderen Umständen Anführungszeichen verwenden sollten, da diese den Text schwerer lesbar machen. Widerstehen Sie der Versuchung, Zitate zu verwenden, um Ihre eigene Geschichte zu zitieren oder etwas zu necken, das Sie sowieso sagen werden. Dies ist selbstverherrlichend und verschwendet die Zeit Ihrer Leser.

Code

Wenn möglich, sollte der Code eher in Textform als in Bildern vorliegen. Dies macht den Code für Screenreader zugänglicher und für Benutzer einfacher zu kopieren und einzufügen. So können Sie das machen:

Hinzufügen von Codeblöcken zu Medium und Verwenden von Einbettungswerkzeugen zur Hervorhebung der Syntax

Medium hat eine versteckte Verknüpfung, die Text in einfachen Text umwandelt medium.freecodecamp.com

Links

Finden Sie heraus, wie Sie einen Link in einen Satz einarbeiten können. 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 Vorschaukarte wie folgt erstellt:

Wie man auf den Schultern von Riesen steht

Erobern Sie das hier nicht erfundene Syndrom und machen Sie dann etwas Neues. medium.freecodecamp.com

Das Unterstreichen von Text erschwert das Lesen, daher werden nur einige Wörter verlinkt.

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

Verwenden Sie ihre Top-Level-Domains, wenn sie Teil ihrer Marke sind, wie 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.

Verwenden Sie diese sparsam, da sie Ihren Leser davon abhalten können, Ihre Geschichte zu beenden.

Akronyme

Verwenden Sie kein Akronym, es sei denn, das Akronym wird besser verstanden als das, wofür es steht. Beispielsweise ist HTTP allgemein anerkannt als das Hypertext Transfer Protocol.

Wenn ein Akronym noch nicht allgemein verstanden ist und Sie mehr als ein paar Mal darauf verweisen, können Sie es folgendermaßen als Akronym definieren:

"Lassen Sie uns den Code in einen abstrakten Syntaxbaum (AST) aufteilen."

Hier habe ich der Einfachheit halber 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 eines Beispiels veranschaulichen.

Vermeiden Sie es, in Ihren ersten Absätzen ein Akronym zu definieren, da dies Ihren Leser verlangsamt und die Wahrscheinlichkeit verringert, dass er weiter liest.

Hier ist die sehr 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 buchstabieren.

Buchstabieren Sie immer kurze mehrteilige Wörter wie JavaScript und Front-End. Kü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 ein paar Wörter hervorzuheben. Diese verlangsamen den Leser und sollten sparsam eingesetzt werden. Verwenden Sie keine fett oder kursiv für Links. Diese fallen bereits durch die Unterstreichung auf.

Verwenden Sie keine Drop Caps. Sie sehen in alten Büchern elegant aus, aber im Internet albern.

Wenn Sie etwas hervorheben möchten, verwenden Sie Fettdruck . Kursivschrift ist schwerer zu lesen. Keine fett gedruckten Hyperlinks - die Linie darunter bietet bereits genügend Betonung.

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 einen Leser verwirren (z. B. mit Variablennamen oder Buchtiteln).

In einigen Teilen der Welt setzen Menschen Leerzeichen vor Doppelpunkte, wie zum Beispiel: Beispiel. Tu das nicht.

Verwenden Sie Englisch anstelle von Latein:

  • Verwenden Sie "zum Beispiel" anstelle von "EG"
  • Verwenden Sie "das ist" anstelle von "IE"
  • Verwenden Sie "Beachten Sie das" anstelle von "NB"
  • Anstatt Listen mit "etc." zu beenden Beginnen Sie sie mit „Gefällt mir“: „Elvis hat Essen wie Brot, Erdnussbutter und Bananen gegessen.“

Laut Google Books haben Semikolons einen langsamen Tod gestorben. Lassen Sie uns sie aus ihrem Elend befreien. Verwenden Sie stattdessen einfach einen Punkt und teilen Sie die Klauseln in separate Sätze auf.

Verwenden Sie nach Möglichkeit das Oxford-Komma. Es macht die Dinge einfacher, klarer und schöner zu lesen.

Stil

Verwenden Sie die Hemingway App. Dieses einfache Tool ist nicht magisch, erkennt jedoch automatisch weitgehend vereinbarte 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 Klassenstufe von 6 erreichen. Und sie sollten danach streben.

Die meisten Menschen sprechen kein Englisch als Muttersprache, und diejenigen, die normalerweise nicht den ganzen Tag Chaucer lesen. Sie wollen, 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.

Halten Sie Ihre Spannung durchgehend konstant. Wenn Sie über etwas sprechen, das in der Vergangenheit aufgetreten ist, verwenden Sie die Vergangenheitsform.

Nennen Sie Ihren Leser "Sie" - nicht "wir" oder "uns". "Wir" werden dieses Tutorial nicht machen, Ihr Leser wird Ihr Tutorial lesen und es selbst machen.

Auch Front-End - Entwicklung (Adjektivform mit einem Bindestrich) ist , wenn man auf dem Arbeits Frontend (Substantiv Form ohne Bindestrich). Das gleiche gilt für das Back-End, den Full-Stack und viele andere zusammengesetzte Begriffe.

Abschließender Rat

Denken Sie daran, dass Sie bei der Veröffentlichung auf Medium Tausende von Menschen bitten, Ihnen einige Minuten ihres Lebens zu geben. Nehmen Sie Ihre Leser nicht als selbstverständlich hin.

Bevor Sie eine Geschichte veröffentlichen, empfehle ich Ihnen, zu schlafen, aufzuwachen und sie dann erneut Korrektur zu lesen.

Wenn Sie kein englischer Muttersprachler sind und auf Englisch schreiben, bitten Sie einen Muttersprachler, Ihre Geschichte Korrektur zu lesen, bevor Sie sie an eine Veröffentlichung senden.

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. Aber lassen Sie sich 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 wahrscheinlich auch nicht viel Mühe darauf verwenden, es zu veröffentlichen.

Oh, und öffnen Sie Ihre Geschichte nicht mit "Dies wurde in meinem Blog unter veröffentlicht" oder "Update: Dies wurde in den Hacker-Nachrichten veröffentlicht." Wenn Sie solche Notizen hinzufügen möchten, setzen Sie sie ganz unten in Ihre Geschichte. Die Leute haben sich nicht zu Ihrer Geschichte durchgeklickt, um sofort weggeschickt zu werden - sie sind gekommen, um Ihre Geschichte zu lesen.

Beachten Sie, dass freeCodeCamp selbst nicht mehr auf Medium veröffentlicht wird. Stattdessen veröffentlichen wir hier. Hier erfahren Sie, wie Sie in der Veröffentlichung von freeCodeCamp veröffentlicht werden.

Wenn Sie mehr über effektives Schreiben auf Medium selbst erfahren möchten, lesen Sie Wie man Medium-Geschichten schreibt, die die Leute tatsächlich lesen.