En stilguide til skrivning på Medium

Efter at have brugt mere end 1.000 timer på at skrive og redigere historier til vores Medium-publikation, har jeg besluttet at oprette denne levende stilvejledning til bidragydere. Du er også velkommen til at bruge den til din publikation.

Overskrifter

Dette er den vigtigste del af din historie, og du bør lægge en seriøs tanke i dem.

Brug ikke clickbait:

"Du vil ikke tro dette ene latterligt effektive overskriften mørke mønster"

Brug ikke lister:

“11 uhyrlige overskrifter, der vil tvinge folk til at læse din Medium-historie”

Fortæl sandheden:

“Smart, men faktisk overskrift om et interessant emne”

Mærk ikke historier, der er del 1 af en serie, "del 1." Det skræmmer folk, da de oplever at læse det som en større tidsforpligtelse. Og hvem ved, hvornår du alligevel kommer rundt til at skrive del 2.

Hvis din overskrift også er for lang, afkortes Medium den. Lange overskrifter kan også forhindre, at dit topbillede vises i nyhedsfeeds.

Billeder

Medium tilbyder fire forskellige billedbredder. Bemærk, at disse alle ser ens ud på mobilen.

Det meste af tiden vil du holde fast i kolonnebredden:

Hvis du har et diagram, der er svært at læse, når det er lille, skal du gå større:

Og hvis du virkelig er stolt af et billede, eller hvis det er fyldt med interessante data, skal du gå fuldt ud:

... og så er der sidestrækning. Brug slet ikke denne størrelse, fordi det gør teksten mindre behagelig at læse.

Det er også akavet, når du er færdig med at tale om billedet, og din tekst stadig skubbes til siden.

Ja. Jeg sidder stadig fast herovre.

Inkluder altid et billede i høj opløsning øverst i en historie under din overskrift. Dette har følgende fordele:

  1. Når folk deler din historie på Facebook og Twitter, vil den være mere fremtrædende i nyhedsfeeds, hvilket gør folk mere tilbøjelige til at klikke på den.
  2. Det vil se bedre ud i Mediums egne nyhedsfeeds.
  3. Mennesker er visuelle væsner og klikker på billeder.

Tilskrivning

Den enkleste måde at tilskrive et billede på er at sætte ordene "Billedkredit" under et billede og linke denne tekst til den oprindelige kilde.

I nogle tilfælde viser det sig muligvis ikke nok for en billedrettighedsindehaver. I praksis har de fleste magasiner og filmstudier dog bedre ting at gøre end at sende ophør og afstå breve til folk, der blot tilskrev deres copyright-beskyttede billeder.

Hvis du leder efter billeder, du sikkert kan bruge uden tilladelse, skal du tjekke Pexels, Unsplash eller søge på Google efter billeder mærket til genbrug.

Plagiering - forkert gengivelse af andres skrivning som din egen - er en alvorlig lovovertrædelse på college, og det er lige så alvorligt på Medium. Tillæg altid citater til de mennesker, der oprindeligt sagde dem. Hvis det er et tilbud med flere linjer, skal du bruge Medium's pull-tilbud:

"Når du har egenvittighed, er det en fornøjelse at kreditere andre for deres."

- Criss Jami

Bemærk, at du under ingen andre omstændigheder ikke bør bruge pull-citater, da de gør teksten sværere at læse. Modstå fristelsen til at bruge træk citater til at citere din egen historie eller drille noget, du alligevel er ved at sige. Dette er selvopladende og spilder dine læseres tid.

Kode

Hvor det er muligt, skal koden være i tekstform i stedet for på billeder. Dette gør koden mere tilgængelig for skærmlæsere og lettere for folk at kopiere og indsætte. Sådan kan du gøre dette:

Sådan tilføjes kodeblokke til Medium og bruger integreringsværktøjer til syntaksfremhævning

Medium har en skjult genvej, der gør tekst til almindelig tekst ... medium.freecodecamp.com

Links

Find ud af en måde at arbejde et link på i en sætning. Hvis et link er afgørende for en historie, skal du sætte det på sin egen linje og trykke på Enter. Dette opretter et eksempelkort, som dette:

Hvordan man står på giganternes skuldre

Conquer Not Invented Here Syndrome, gør derefter noget nyt. medium.freecodecamp.com

Understregning af tekst gør det sværere at læse, så kun hyperlink et par ord.

Indsæt ikke URLS direkte, sådan her: //www.example.com

Brug deres topdomæner, hvis det er en del af deres brand, som art.com.

Indlejring af medier

Du kan integrere tweets, YouTube-videoer og andre medier ved at indsætte deres URL'er i Medium på en ny linje og derefter trykke på enter.

Brug disse sparsomt, da de kan distrahere din læser fra at afslutte din historie.

Akronymer

Brug ikke et akronym, medmindre akronymet forstås bredere end hvad det står for. For eksempel er HTTP mere bredt anerkendt end Hypertext Transfer Protocol.

Hvis et akronym ikke allerede er bredt forstået, og du vil henvise til det mere end et par gange, kan du definere det som et akronym ved at gøre dette:

"Lad os nedbryde koden i et abstrakt syntaks-træ (AST)."

Her linkede jeg også til Wikipedia-artiklen for læsernes bekvemmelighed. Antag ikke, at folk læser disse eksterne links. Du skal stadig definere begreber eller illustrere dem gennem eksempler.

Undgå at definere et akronym i dine indledende afsnit, da det bremser din læser ned og gør dem mindre tilbøjelige til at fortsætte med at læse.

Her er den meget korte liste over teknologiske akronymer, som du ikke behøver at definere: API, AJAX, BIOS, CPU, CSS, HTML, HTTPS, LAN, RAM, REST, USB, WWW, XML. For alt andet skal du stave det ud.

Skriv altid korte ord med flere dele som JavaScript og frontend. Forkort dem ikke - kortfattetheden er ikke den mulige forvirring værd.

Tekstformatering

Du kan bruge fed eller kursiv - aldrig begge dele - for at lægge vægt på et par ord. Disse bremser læseren ned og skal bruges sparsomt. Brug ikke fed eller kursiv på links. Disse skiller sig allerede ud på grund af understregningen.

Brug ikke drop caps. De ser elegante ud i gamle bøger, men fjollede på nettet.

Hvis du vil fremhæve noget, skal du bruge fed skrift . Kursiv er sværere at læse. Du må ikke dristige hyperlinks - linjen under dem giver allerede tilstrækkelig vægt.

Brug kun et udråbstegn, typisk kun efter udråb som: Golly gee! Hotdog!

Sæt kommaer og punktum i anførselstegn, undtagen når det kan forvirre en læser (som med variable navne eller bogtitler).

I nogle dele af verden sætter folk mellemrum foran kolon, som dette: eksempel. Gør ikke dette.

Brug engelsk i stedet for latin:

  • Brug "for eksempel" i stedet for "EG"
  • Brug "det er" i stedet for "IE"
  • Brug "note that" i stedet for "NB"
  • I stedet for at afslutte lister med “osv.” start dem med "som": "Elvis spiste mad som brød, jordnøddesmør og bananer."

Ifølge Google Books har semikoloner død en langsom død. Lad os lægge dem ud af deres elendighed. Brug bare et punktum i stedet og opdel klausuler i separate sætninger.

Brug Oxford Comma, når det er muligt. Det gør tingene nemmere, klarere og pænere at læse.

Stil

Brug Hemingway-appen. Der er ikke noget magisk ved dette enkle værktøj, men det registrerer automatisk meget aftalte stilproblemer:

  • passiv stemme
  • unødvendige adverb
  • ord, der har mere almindelige ækvivalenter

Hemingway-appen tildeler et "karakterniveau" til din skrivning. Selv tekniske historier kan få karakterniveauet 6. Og de skal stræbe efter.

De fleste mennesker er ikke engelsktalende, og de der normalt ikke sidder og læser Chaucer hele dagen. De vil have deres information tilgængelig og til det punkt.

Fejl ved siden af ​​at nedbryde lange sætninger og afsnit i kortere.

Brug sammentrækninger. De får din prosa til at virke mere samtalende. Det er altid et plus.

Hold din spænding konstant hele vejen igennem. Hvis du taler om noget, der opstod i fortiden, skal du bruge fortid.

Henvis til din læser som "dig" - ikke "vi" eller "os." ”Vi” vil ikke gøre denne tutorial, din læser vil læse din tutorial og gøre det på egen hånd.

Også, frontend- udvikling (adjektiv form, med en streg) er, når du arbejder på forreste ende (navneord formular uden bindestreg). Det samme gælder bagenden, fuld stak og mange andre sammensatte termer.

Endelig rådgivning

Husk, at når du udgiver på Medium, beder du tusinder af mennesker om at give dig flere minutter af deres liv. Tag ikke dine læsere for givet.

Inden du udgiver en historie, anbefaler jeg, at du sover, vågner op og derefter korrekturlæser den igen.

Hvis du ikke er engelsk som modersmål og skriver på engelsk, skal du bede en indfødt taler om at korrekturlæse din historie, inden du sender den til en publikation.

Når du sender din historie til en publikation, skal du forvente, at redaktører rent faktisk redigerer den. Husk, at disse mennesker bruger meget mere tid på at redigere historier, end du gør, og har en mere udviklet følelse af "hvad der virker." Men lad ikke dette forhindre dig i at stille spørgsmål og rette eventuelle faktiske unøjagtigheder, de måtte indføre.

Vær forsigtig med publikationer, der udgiver din historie uden at foretage ændringer. Hvis de ikke gider at redigere det (eller endda læse det?), Lægger de sandsynligvis heller ikke meget på at offentliggøre det.

Åh, og åbn ikke din historie med "Dette blev offentliggjort på min blog kl." Eller "opdatering: dette er blevet sendt på Hacker News." Hvis du vælger at tilføje noter som denne, skal du placere dem helt nederst i din historie. Folk klikkede ikke igennem på din historie for kun at blive sendt væk - de kom for at læse din historie.

Bemærk, at freeCodeCamp i sig selv ikke længere udgives på Medium. I stedet offentliggør vi her. Sådan offentliggøres i freeCodeCamp's publikation.

Hvis du vil lære mere om effektiv skrivning på selve Medium, skal du læse Sådan skriver du mellemstore historier, som folk faktisk læser.