Teknisk skrivning for begyndere - En AZ-guide til grundlæggende teknologiblogging

Hvis du elsker skrivning og teknologi, kan teknisk skrivning være en passende karriere for dig. Det er også noget andet, du kan gøre, hvis du elsker tech, men ikke rigtig har lyst til at kode hele dagen.

Teknisk skrivning kan også være noget for dig, hvis du elsker at lære ved at undervise andre, bidrage til open source-projekter og lære andre hvordan man også gør det eller dybest set nyder at forklare komplekse koncepter på enkle måder gennem din skrivning.

Lad os dykke ned i det grundlæggende og lære om, hvad du bør vide og overveje, når du kommer i gang med teknisk skrivning.

Indholdsfortegnelse

I denne artikel ser vi på:

  • Hvad teknisk skrivning er
  • Fordele ved teknisk skrivning
  • Nødvendige færdigheder at have som teknisk forfatter
  • Den tekniske skriveproces
  • Platforme til offentliggørelse af dine artikler
  • Tekniske skrivekurser
  • Tekniske skriveforum og samfund
  • Nogle fantastiske tekniske forfattere at følge
  • Afsluttende ord og referencer

Hvad er teknisk skrivning?

Teknisk skrivning er kunsten at levere detaljeret orienteret instruktion for at hjælpe brugerne med at forstå en bestemt færdighed eller et bestemt produkt.

Og en teknisk forfatter er en, der skriver disse instruktioner, ellers kendt som teknisk dokumentation eller tutorials. Dette kan omfatte brugervejledninger, online supportartikler eller interne dokumenter til kodere / API-udviklere.

En teknisk forfatter kommunikerer på en måde, der præsenterer teknisk information, så læseren kan bruge disse oplysninger til et bestemt formål.

Fordele ved teknisk skrivning

Tekniske forfattere er livslang lærende. Da jobbet involverer kommunikation af komplekse koncepter i enkle og ligetil udtryk, skal du være velbevandret i det felt, du skriver om. Eller vær villig til at lære om det.

Dette er fantastisk, for med hvert nye tekniske dokument, du undersøger og skriver, bliver du ekspert på dette emne.

Teknisk skrivning giver dig også en bedre følelse af brugerindlevelse. Det hjælper dig med at være mere opmærksom på, hvad læserne eller brugerne af et produkt føler snarere end hvad du synes.

Du kan også tjene penge som teknisk forfatter ved at bidrage til organisationer. Her er nogle organisationer, der betaler dig for at skrive for dem, som Smashing Magazine, AuthO, Twilio og Stack Overflow.

Ud over alt dette kan du bidrage til Open Source-samfund og deltage i betalte open source-programmer som Google Season of Docs og Outreachy.

Du kan også tilmelde dig teknisk skrivning som et fuldtidsyrke - mange virksomheder har brug for nogen med disse færdigheder.

Nødvendige færdigheder at have som teknisk forfatter

Forstå brugen af ​​korrekt engelsk

Før du overvejer at skrive, er det nødvendigt at have en god forståelse af engelsk, dens tidspunkter, stavemåder og grundlæggende grammatik. Dine læsere vil ikke læse en artikel, der er fyldt med forkert grammatik og dårlige ordvalg.

Vide, hvordan man forklarer tingene klart og enkelt

At vide, hvordan man implementerer en funktion, betyder ikke nødvendigvis, at du klart kan kommunikere processen til andre.

For at være en god lærer skal du være empatisk med evnen til at undervise eller beskrive termer på måder, der passer til dit tiltænkte publikum.

Hvis du ikke kan forklare det til en seksåring, forstår du det ikke selv. Albert Einstein

Besidder nogle skrivefærdigheder‌‌

Jeg tror, ​​at forfattere er skabt, ikke født. Og du kan kun lære at skrive ved faktisk at skrive.

Du ved måske aldrig, at du har det i dig at skrive, før du lægger pen på papir. Og der er kun en måde at vide, om du har nogle skrivefærdigheder, og det er ved at skrive.

Så jeg opfordrer dig til at begynde at skrive i dag. Du kan vælge at starte med en hvilken som helst af de platforme, jeg har angivet i dette afsnit for at strække dine skrivemuskler.

Og selvfølgelig er det også en enorm fordel at have en vis erfaring inden for et teknisk felt.

Den tekniske skriveproces

Analyser og forstå, hvem dine læsere er

Den største faktor, du skal overveje, når du skriver en teknisk artikel, er dit tiltænkte / forventede publikum. Det skal altid være i spidsen for dit sind.

En god teknisk forfatter skriver ud fra læsernes sammenhæng. Lad os som et eksempel sige, at du skriver en artikel, der er målrettet mod begyndere. Det er vigtigt ikke at antage, at de allerede kender visse begreber.

Du kan starte din artikel ved at skitsere alle nødvendige forudsætninger. Dette vil sikre, at dine læsere har (eller kan tilegne sig) den viden, de har brug for, før de dykker direkte ind i din artikel.

Du kan også inkludere links til nyttige ressourcer, så dine læsere kan få de oplysninger, de har brug for med et enkelt klik.

For at vide hvem du skriver, skal du samle så mange oplysninger som muligt om, hvem der vil bruge dokumentet.

Det er vigtigt at vide, om dit publikum har ekspertise inden for området, om emnet er helt nyt for dem, eller om de falder et sted imellem.

Dine læsere vil også have deres egne forventninger og behov. Du skal bestemme, hvad læseren leder efter, når de begynder at læse dokumentet, og hvad de får ud af det.

For at forstå din læser skal du stille dig selv følgende spørgsmål, inden du begynder at skrive:

  • Hvem er mine læsere?
  • Hvad har de brug for?
  • Hvor vil de læse?
  • Hvornår læser de?
  • Hvorfor læser de?
  • Hvordan vil de læse?

Disse spørgsmål hjælper dig også med at tænke over din læseroplevelse, mens du læser din skrivning, som vi vil tale mere om nu.

Tænk på brugeroplevelse

Brugeroplevelse er lige så vigtig i et teknisk dokument, som det er hvor som helst på nettet.

Nu hvor du kender dit publikum og deres behov, skal du huske, hvordan selve dokumentet imødekommer deres behov. Det er så let at ignorere, hvordan læseren rent faktisk vil bruge dokumentet.

Når du skriver, skal du løbende gå tilbage og se dokumentet som om du er læseren. Spørg dig selv: Er det tilgængeligt? Hvordan bruger dine læsere det? Hvornår bruger de det? Er det let at navigere?

Målet er at skrive et dokument, der både er nyttigt og nyttigt af dine læsere.

Planlæg dit dokument

Når du husker, hvem dine brugere er, kan du derefter konceptualisere og planlægge dit dokument.

Denne proces inkluderer et antal trin, som vi gennemgår nu.

Udfør grundig forskning om emnet

Mens du planlægger dit dokument, skal du undersøge det emne, du skriver om. Der er masser af ressourcer, kun en Google-søgning væk, som du kan forbruge og få dybere indsigt fra.

Vær ikke fristet til at fjerne andres værker eller artikler og videregive det som dit eget, da dette er plagiering. Brug snarere disse ressourcer som referencer og ideer til dit arbejde.

Google så meget som muligt, få fakta og tal fra forskningstidsskrifter, bøger eller nyheder, og saml så meget information som muligt om dit emne. Så kan du begynde at lave en oversigt.

Lav en oversigt

At skitsere indholdet af dit dokument, før du udvider det, hjælper dig med at skrive på en mere fokuseret måde. Det giver dig også mulighed for at organisere dine tanker og nå dine mål for din skrivning.

En oversigt kan også hjælpe dig med at identificere, hvad du vil have dine læsere til at komme ud af dokumentet. Og endelig opretter det en tidslinje til færdiggørelse af din skrivning.

Få relevant grafik / billeder

At have en oversigt er meget nyttigt til at identificere de forskellige virtuelle hjælpemidler (infografik, gifs, videoer, tweets), du skal integrere i forskellige sektioner i dit dokument.

Og det gør din skriveproces meget lettere, hvis du holder denne relevante grafik praktisk.

Skriv i den korrekte stil

Endelig kan du begynde at skrive! Hvis du har gennemført alle disse trin, skal skrivning blive meget lettere. Men du skal stadig sikre dig, at din skrivestil passer til et teknisk dokument.

Skrivningen skal være tilgængelig, direkte og professionel. Blomstrende eller følelsesmæssig tekst er ikke velkommen i et teknisk dokument. For at hjælpe dig med at opretholde denne stil er her nogle nøgleegenskaber, du skal dyrke.

Brug Active Voice

Det er en god ide at bruge aktive stemmer i dine artikler, da det er lettere at læse og forstå end den passive stemme.

Aktiv stemme betyder, at emnet af sætningen er den ene aktivt udfører handlingen af verbet. Passiv stemme betyder, at et emne er modtageren af ​​et verbs handling .

Her er et eksempel på passiv stemme : Dokumentationen skal læses seks gange om året af hver webudvikler.

Og her er et eksempel på aktiv stemme : Hver webudvikler skal læse denne dokumentation 6 gange om året.

Vælg dine ord omhyggeligt

Ordvalg er vigtigt. Sørg for at bruge det bedste ord til konteksten. Undgå overdreven brug af pronomen som 'det' og 'dette', da læseren kan have svært ved at identificere hvilke navneord de henviser til.

Undgå også slang og vulgært sprog - husk at du skriver til et bredere publikum, hvis disposition og kulturelle tilbøjeligheder kan afvige fra dit.

Undgå overdreven jargon

Hvis du er ekspert inden for dit felt, kan det være let at bruge jargon, du kender uden at indse, at det kan være forvirrende for andre læsere.

Du bør også undgå at bruge akronymer, som du ikke tidligere har forklaret.

Her er et eksempel :

Mindre klart: PWA'er betragtes virkelig som fremtiden for udvikling af flere platforme. Deres tilgængelighed på både Android og iOS gør dem til fremtidens app.

Forbedret: Progressive webapplikationer (PWA'er) er virkelig fremtiden for udvikling af flere platforme. Deres tilgængelighed på både Android og iOS gør PWA til fremtidens app.

Brug almindeligt sprog

Brug færre ord, og skriv på en måde, så enhver læser kan forstå teksten. ‌‌ Undgå store, lange ord. Forsøg altid at forklare begreber og udtryk på den klarest mulige måde.

Visuel formatering

En tekstvæg er vanskelig at læse. Selv de klareste instruktioner kan gå tabt i et dokument, der har dårlig visuel repræsentation.

De siger, at et billede er tusind ord værd. Dette gælder selv i teknisk skrift.

Men ikke bare ethvert billede er et teknisk dokument værd. Teknisk information kan være vanskelig at formidle i tekst alene. Et velplaceret billede eller diagram kan tydeliggøre din forklaring.

Folk elsker også grafik, så det hjælper med at indsætte dem på de rigtige steder. Overvej billederne nedenfor:

Først her er et bloguddrag uden visuals:

Her er et uddrag af samme blog, men med visuals:

Tilføjelse af billeder til dine artikler gør indholdet mere relatabelt og lettere at forstå. Ud over billeder kan du også bruge gifs, emoji, embeds (sociale medier, kode) og kodestykker, hvor det er nødvendigt.

Tankevækkende formatering, skabeloner og billeder eller diagrammer vil også gøre din tekst mere nyttig for dine læsere. Du kan tjekke referencerne nedenfor for en teknisk skriveskabelon fra @Bolajiayodeji.

Lav en omhyggelig gennemgang

God skrivning af enhver art skal være fri for stavefejl og grammatiske fejl. Disse fejl kan synes åbenlyse, men det er ikke altid let at få øje på dem (især i lange dokumenter).

Dobbeltkontrol altid din stavning (du ved, prik din Is og kryds din Ts), inden du trykker på 'publish'.

Der er et antal gratis værktøjer som Grammarly og Hemingway-appen, som du kan bruge til at kontrollere for grammatik og stavefejl. Du kan også dele et udkast til din artikel med nogen til korrekturlæsning, inden du offentliggør det.

Hvor skal du offentliggøre dine artikler

Nu hvor du har besluttet at begynde med teknisk skrivning, er der nogle gode platforme, hvor du kan begynde at oprette teknisk indhold gratis. De kan også hjælpe dig med at opbygge en tiltalende portefølje, som fremtidige arbejdsgivere kan tjekke ud.

Dev.to er et samfund bestående af tusinder af teknologier, hvor både forfattere og læsere meningsfuldt engagerer og deler ideer og ressourcer.

Hashnode er min go-to blogging platform med fantastiske frynsegoder såsom tilpasset domæne kortlægning og et interaktivt samfund. Det er også nemt og hurtigt at oprette en blog på denne platform.

freeCodeCamp har et meget stort samfund og publikums rækkevidde og er et godt sted at udgive dine artikler. Du skal dog ansøge om at skrive til deres publikation med nogle tidligere skriveprøver.

Din ansøgning kan enten accepteres eller afvises, men frarådes ikke. Du kan altid ansøge igen senere, når du bliver bedre, og hvem ved det? Du kan blive accepteret.

Hvis du skriver for dem, gennemgår de og redigerer dine artikler, inden de offentliggøres, for at sikre, at du udgiver den mest polerede artikel. De deler også dine artikler på deres sociale medieplatforme for at hjælpe flere mennesker med at læse dem.

Hackernoon har over 7.000 forfattere og kan være en god platform for dig at begynde at offentliggøre dine artikler til de over 200.000 daglige læsere i samfundet.

Hacker Noon understøtter forfattere ved korrekturlæsning af deres artikler, inden de offentliggøres på platformen, hvilket hjælper dem med at undgå almindelige fejl.

Tekniske skrivekurser

Ligesom i alle andre områder er der forskellige processer, regler, bedste praksis og så videre i teknisk skrivning.

At tage et kursus i teknisk skrivning hjælper dig med at guide dig igennem alle ting, du har brug for at lære, og kan også give dig et stort boost af selvtillid til at starte din skriverejse.

Her er nogle tekniske skrivekurser, du kan tjekke ud:

  • Googles tekniske skrivekursus (gratis)
  • Udemy teknisk skrivekursus (betalt)
  • Hashnode Technical Writing Bootcamp (gratis)

Tekniske skriveforum og samfund

Alene kan vi gøre så lidt sammen, vi kan gøre så meget ~ Helen Keller

At være en del af et samfund eller forum sammen med mennesker, der deler samme lidenskab som dig, er gavnligt. Du kan få feedback, rettelser, tip og endda lære nogle stiltip fra andre forfattere i samfundet.

Her er nogle samfund og fora, som du kan deltage i:

  • Hashnode
  • Dev.to
  • Teknisk skrivende verden
  • Teknisk forfatterforum
  • Skriv Docs Forum

Nogle fantastiske tekniske forfattere at følge

På min tekniske skriverejse er jeg kommet og fulgt nogle gode tekniske forfattere, hvis skriverejse, konsistens og stil inspirerer mig.

Dette er de forfattere, som jeg ser op til og betragter virtuelle mentorer om teknisk skrivning. Nogle gange dropper de tekniske skrivetips, som jeg finder nyttige og har lært meget af.

Her er nogle af disse forfattere (hyperlinket med deres twitter-håndtag):

  • Quincy Larson
  • Edidiong Asikpo
  • Catalin Pit
  • Victoria Lo
  • Bolaji Ayodeji
  • Amruta Ranade
  • Chris Bongers
  • Colby Fayock

Afsluttende ord

Du har ikke brug for en grad i teknisk skrivning for at begynde at lægge teknisk indhold ud. Du kan begynde at skrive på din personlige blog og offentlige GitHub-arkiver, mens du bygger din portefølje og får praktisk erfaring.

Virkelig - Bare start med at skrive.

Øv dig ved at oprette nye dokumenter til eksisterende programmer eller projekter. Der er et antal open source-projekter på GitHub, som du kan tjekke ud og tilføje til deres dokumentation.

Er der en app, som du elsker at bruge, men dokumentationen er dårligt skrevet? Skriv din egen og del den online for feedback. Du kan også hurtigt oprette din blog på hashnode og begynde at skrive.

Du lærer at skrive ved at skrive og ved at læse og tænke på, hvordan forfattere har skabt deres karakterer og opfundet deres historier. Hvis du ikke er læser, skal du ikke engang tænke på at være forfatter. - Jean M. Auel

Tekniske forfattere lærer altid . Ved at dykke ned i nye fagområder og modtage ekstern feedback stopper en god forfatter aldrig med at finpudse deres håndværk.

Selvfølgelig er gode forfattere også glupske læsere. Ved at gennemse højt læste eller meget anvendte dokumenter vil din egen skrivning helt sikkert blive bedre.

Kan ikke vente med at se dine tekniske artikler!

Referencer

Introduktion til teknisk skrivning‌‌

Sådan strukturerer du en teknisk artikel‌‌

Forstå dit publikum, hvorfor og hvordan

TemplateTeknisk skriveskabelon

Jeg håber, det var nyttigt. I så fald følg mig på Twitter og lad mig det vide!