Hvad er teknisk skrivning? En komplet guide

Når du har problemer med en ny gadget, rækker du ud efter manualen.

Når du sidder fast i opsætningen af software, tjekker du hjælpesiderne.

Når din bil laver en underlig lyd, bladrer du i manualen i handskerummet.

Alle disse er eksempler på teknisk skrivning - noget, vi er afhængige af hver dag, men sjældent tænker over.

Ifølge Glassdoor tjener en teknisk skribent hos SpaceX mellem $88,000 til $138,000 om året. 

Alligevel forstår de fleste stadig ikke, hvad teknisk skrivning egentlig er.

Det er ikke kun skriver op instruktioner.

Det er ikke kun oversætter Ingeniørsprog til almindeligt engelsk.

Og det er ikke engang kun skabe brugermanualer eller hjælpedokumenter. 

Så hvad er teknisk skrivning? Hvordan adskiller det sig fra andre typer skrivning? Hvad er de forskellige former? Hvordan kan man blive teknisk skribent? Og hvordan kan AI hjælpe undervejs? 

Alt det - og meget mere - fortæller vi om i denne blog. Lad os dykke ned i det! 

Hvad er teknisk skrivning?

I lægmandssprog betyder teknisk skrivning, at man tager de vanskelige og detaljerede emner og forklarer dem på en måde, så alle (med den rette baggrund) kan følge med. 

For eksempel, Dette inkluderer:

• Brugervejledninger - Det hæfte, der fulgte med din telefon? Det er teknisk skrivning.
• API-dokumentation - Udviklere har også brug for instruktioner. API'er forklarer ikke sig selv.
• Tekniske rapporter - Ingeniører og forskere bruger dem til at dele forskning og resultater.

Teknisk skrivning er ikke bare det, du skriver, men hvordan du skriver det. Den bruger:

• Imperativ stemning - I stedet for "Du skal klikke på knappen," Det er bare "Klik på knappen." 

• Passiv stemme (når det er nødvendigt) -. Hvis det er ligegyldigt, hvem der udførte handlingen, hjælper passiv stemme. "Filen blev slettet" fungerer bedre end "Nogen har slettet filen" hvis fokus er på filen.

Nogle mennesker tror, at teknisk skrivning kun er at skrive til SaaS-produkter eller tekniske blogs. 

Men det handler ikke om markedsføring eller historiefortælling. 

Teknisk skrivning har mange forskellige typer (vi kommer ind på det om lidt) - alle med samme formål: At præsentere informationen på en præcis, klar og funktionel måde. 

Hvordan teknisk skrivning adskiller sig fra andre skrivestile

Lad os forstå seks aspekter, som gør, at teknisk skrivning adskiller sig fra andre skrivestile.

Kreative forfattere bruger tvetydighed eller metaforer til at skabe en engagerende faktor for publikum. 

Tekniske skribenter tilstræber ingen tvetydighed. 

De vil gerne prioritere klarhed frem for kreativ udfoldelse, men sådan er dette arbejde. 

Hvorfor teknisk skrivning er vigtig i forskellige brancher

Forestil dig en pilot, der læser denne manual midt under flyvningen, når han har brug for at forstå noget vigtigt:

"Juster trykvektoren for at kompensere for asymmetrisk fremdriftsanomali ved at implementere standardafvigelsesprotokol 5.3b med hensyn til atmosfæriske tæthedsvariabler"

Eller forestil dig en kirurg, der gennemgår retningslinjerne for proceduren lige før en kritisk operation: 

"Snit parallelt med fasciale planer under hensyntagen til underliggende neurovaskulære strukturer, mens du opretholder hæmostase i hele dissektionssekvensen." 

Selv hvis de er læger eller piloter, som har studeret dette hele deres karriere, ville de ikke have lyst til at læse dette i en nødsituation. 

Det skaber forvirring og frustration, som alle gerne vil undgå, uanset situationen.

Lad os se på fem vigtige grunde til, at teknisk skrivning er et absolut must: 

1. Risikoreduktion og compliance - I brancher som sundhedsvæsen, finans og luftfart er fejl ikke bare dyre - de kan være dødbringende. 
   • For eksempel, Hvad nu, hvis en sygeplejerske fejlfortolker doseringsinstruktionerne på grund af uklar ordlyd? Korrekt dokumentation forhindrer disse fejl. 

2. Bevarelse og overførsel af viden - Folk forlader deres job, bliver forfremmet eller går på pension. Men hvad sker der med al den viden, de har i hovedet? De dokumenteres korrekt ved hjælp af teknisk skrivning. En veldokumenteret proces betyder, at den næste person kan træde til uden at starte fra bunden.

3. Kundetilfredshed og reducerede supportomkostninger - Har du nogensinde prøvet at sætte en ny enhed op og endt med at se en tilfældig YouTube-tutorial, fordi manualen ikke gav nogen mening? Dårlig dokumentation frustrerer kunderne og belaster supportteams med unødvendige opkald. En velskrevet vejledning sparer alt dette. 

4. Juridisk beskyttelse - Kontrakter, politikker og sikkerhedsretningslinjer fungerer som bevismateriale i tvister.
   • For eksempel, Hvis en virksomhed bliver sagsøgt for et defekt produkt, er det første, advokaterne tjekker, dokumentationen. Advarede instruktionerne om risici? Var sikkerhedsprocedurerne tydeligt beskrevet? Hvis ikke, har virksomheden problemer.

5. Effektivitetsgevinster gennem standardisering - Forestil dig en virksomhed, hvor hver afdeling følger et forskelligt system til den samme opgave. Et team sporer data på regneark, et andet bruger brugerdefineret software, og et tredje "husker bare tingene". Det er noget rod. Teknisk skrivning sikrer, at processerne er standardiserede, gentagelige og skalerbare.

I bund og grund hjælper teknisk skrivning med at forhindre forvirring, spare tid og beskytte folk. 

Typer af teknisk skrivning (med eksempler)

Mange mennesker hører "teknisk skrivning" og tænker straks på tørre, robotagtige brugervejledninger - den slags, som ingen læser, medmindre de sidder helt fast. 

Men teknisk skrivning er meget mere end det. 

I virkeligheden findes det i næsten alle brancher og i mange forskellige former, som hver især tjener et bestemt formål.

Her er de seks vigtigste typer af teknisk skrivning (med eksempler):

1. Teknisk dokumentation - Dette er den klassiske type. Den indeholder brugermanualer, produktvejledninger og fejlfindingsinstruktioner.  
   • For eksempel, Du har lige købt en helt ny espressomaskine, og du er forvirret over de mange knapper. I stedet for at gætte åbner du brugervejledningen og følger trin-for-trin-guiden for at lave din første kop.
     
2. Dokumentation af processen - Alle virksomheder har arbejdsgange, men hvis de kun findes i nogens hoved, er det en katastrofe, der venter på at ske. Disse kaldes SOP'er. 
   • For eksempel, Man skal lave et bageris karakteristiske surdej. Uden en SOP ville hvert brød være forskelligt. Heldigvis beskriver SOP'en hvert trin - nøjagtige målinger, hævetider, bagetemperaturer - hver gang.
     
3. API-dokumentation - Hvis software er hjernen, API'er (Application Programming Interfaces) er nervesystemet. 
   • For eksempel, En app til samkørsel vil have trafikdata i realtid, så den integrerer Google Maps' API. Uden klare API-dokumenter ville de stå over for endeløse forsøg og fejl.
     
4. Videnskabelige/forskningsartikler - De er skrevet af forskere, men skal kunne læses af hele verden.  
   • For eksempelEn ny kræftbehandling ser lovende ud, men før den tages i brug, skal forskere offentliggøre forskning om, hvordan den virker, dens bivirkninger og overlevelsesrater. Andre gennemgår dataene for at verificere dem.
     
5. Hvidbøger og casestudier - Hvidbøger er de "overbevisende argumenter" i den tekniske verden. Casestudier går videre og viser succeshistorier fra den virkelige verden med faktiske resultater. 
   • For eksempel, Et cybersikkerhedsfirma advarer om en ny banktrussel i en hvidbog. En måned senere deler de et casestudie om, hvordan deres værktøj stoppede et angreb. Bankerne begynder at være opmærksomme.
     
6. Dokumentation for lovgivning/overensstemmelse - Sundhedspleje, finans og produktion er afhængige af regler. Compliance-dokumenter hjælper virksomheder med at følge lovene og undgå bøder, retssager og offentlige katastrofer.
   • For eksempel, Et medicinalfirma skal bevise, at et nyt smertestillende middel er sikkert, før det sælges. De indsender dokumenter med ingredienser, dosering og bivirkninger for at undgå juridiske problemer.

Nøglefærdigheder, der kræves til teknisk skrivning

Hvis du nogensinde har lært dine bedsteforældre at bruge en smartphone uden at få dem til at føle sig dumme, så kan du blive teknisk skribent, for det er kernekompetencen.

Alle andre færdigheder kan læres. Her er en liste over færdigheder, som en teknisk skribent skal have:

• Forskningsevner - Du behøver ikke at vide alt, men du skal vide, hvordan du finder nøjagtige og pålidelige oplysninger.
  
• Analyse af målgruppen - At vide, hvem dine læsere er, hvad de allerede ved, og hvad de har brug for at opnå, er det, der gør din skrivning nyttig. For den måde, du forklarer en softwareopdatering på til en udvikler, er ikke den samme, som du ville forklare den til en kunde.
  
• Klar kommunikation/klare sprogfærdigheder - Teknisk skrivning handler ikke om at lyde klog - det handler om at få andre til at føle sig kloge. Det betyder, at du skal fjerne jargonen, bruge et enkelt sprog og skrive så klart, at læseren aldrig behøver at gætte, hvad du mener.
  
• Informationsarkitektur - Læsere læser ikke altid fra start til slut, de scanner. Du skal forstå, hvordan du organiserer indholdet med overskrifter, punktopstillinger og et logisk flow, så oplysningerne er lette at finde og fordøje.
  
• Visuel kommunikation - Nogle gange forklarer et billede noget hurtigere end et afsnit. Flowcharts, kommenterede skærmbilleder og infografik kan forenkle selv de mest forvirrende koncepter. En god teknisk skribent ved, hvornår han skal skrive, og hvornår han skal vise.
  
• Færdighed i værktøj - Kendskab til de rigtige værktøjer fremskynder processen. For eksempel omfatter dokumentationssoftware MadCap Flare eller Confluence, og designværktøjer er Snagit eller Figma.

• Færdigheder i redigering og revision-Det første udkast er aldrig perfekt. Tekniske forfattere skal finpudse deres arbejde for at sikre klarhed, nøjagtighed og fuldstændighed og sikre, at hvert ord tjener et formål. Det handler om at gøre dokumentet så let at bruge som muligt.

Hvem bruger teknisk skrivning? (Brancher, der har brug for det)

Her er de fire brancher, der har størst behov for teknisk skrivning.

Sådan bliver du teknisk skribent 

Her er en trin-for-trin-guide til at komme ind på dette område:

Trin # 1 - Lær det grundlæggende

Du behøver ikke en uddannelse i kommunikation eller engelsk for at komme i gang.

Du kan træde ind og trives i denne karriere, selv om du er lærer, journalist, ingeniør eller endda en person fra det medicinske område.

Tag begyndervenlige kurser og certificeringer på Coursera, Udemyeller Googles kursus i teknisk skrivning. 

Følg branche-blogs som  Skriv dokumenterne og STC (Selskabet for teknisk kommunikation).

Trin # 2 - Opbyg en portefølje

Vælg et produkt, du bruger dagligt (f.eks. en kaffemaskine, en fitness-app eller en smart højttaler), og skriv en brugervejledning eller en fejlfindingsguide. 

Ville det være perfekt? Nej, det ville det ikke. 

Ville det give dig noget konkret at vise? Helt sikkert. 

Open source-fællesskabet som GitHub er åben for nye tekniske skribenter. 

Mange projekter har desperat brug for hjælp til dokumentation, og de er ligeglade med, om du er ny. 

Trin # 3 - Få en rolle på indgangsniveau

Fokuser på stillinger med "junior" eller "associate" i titlen på platforme som LinkedIn, Det er sandt.og Vi arbejder på afstand. 

Du må heller ikke overse kontraktstillinger - de er ofte lettere at få og kan føre til faste stillinger.

Trin # 4 - Få fart på din karriere

Når du har selvtillid og erfaring, kan du gå efter en stilling som senior teknisk skribent, API-skribent eller UX-skribent.

Bliv fortrolig med værktøjer som MadCap Flareog Oxygen XML til struktureret skrivning eller Markdown og Git hvis du vil arbejde med udviklere. Men du behøver ikke at mestre alt på én gang.

Trin # 5 - Forbered dig på interviews

• Almindelige spørgsmål inkluderer:
  • Hvordan forenkler man et komplekst emne? → Vis en før-og-efter-skriveprøve.
  • Hvilke værktøjer har du brugt? Nævn dem alle sammen.
  • Hvordan håndterer du feedback fra ingeniører? → Giv et virkeligt eller hypotetisk eksempel. 

Trin # 6 - Bliv ved med at lære og gå op i niveau

Området udvikler sig konstant. Det ene år taler alle om wikier, det næste handler det om dokumenter som kode. 

De mennesker, der trives, er dem, der bliver ved med at opkvalificere sig. 

Følg med TechWhirl og Kirsebærblad for trends.

Begynd i dag. Skriv manualen til et produkt om, del den på LinkedIn, og bed om feedback.

Værktøjer og software til teknisk skrivning

AI-værktøjer gør dine opgaver lettere og mere effektive - og teknisk skrivning er ikke anderledes.

Her er de tekniske skriveværktøjer, der bruges af professionelle:

1. Til udarbejdelse og redigering af indhold:

1. MS Word giver dig mulighed for at skabe professionelt formaterede dokumenter med præcis kontrol over stilarter, overskrifter og krydshenvisninger. 
2. Google Dokumenter gør det muligt for flere teammedlemmer at arbejde samtidigt på det samme dokument. 

2. Til struktureret dokumentation og udgivelse: 

1. MadCap Flare giver dig mulighed for at vedligeholde en enkelt kilde til indhold, som automatisk udgives i forskellige formater. 
2. Adobe FrameMaker håndterer din 500-siders tekniske specifikation med komplekse tabeller, specialiserede diagrammer og krydshenvisninger. 

3. Til teambaseret dokumentation:

1. Sammenhæng bliver din virksomheds interne wiki, hvor forskellige afdelinger vedligeholder deres dokumentation. 
2. Forestilling hjælper dit produktteam med at organisere dokumentation sammen med projektstyring. 

4. Til styring og sporing af dokumentændringer:

1. GitHub gør det muligt for udviklere at opdatere dokumentation sammen med kodeændringer.
2. BitBucket integreres med din CI/CD-pipeline, så dokumentationen automatisk bygges og distribueres med hver udgivelse.

5. Til forskning, indholdsstruktur og bedre læsbarhed:

1. Essay-forfatter hjælper dig med at dokumentere en sofistikeret algoritme i en passende kontekst, med forklaringer og eksempler. 
2. SEO-skribent sikrer, at din dokumentation, der henvender sig til offentligheden, bruger ensartet terminologi og følger bedste praksis for læsbarhed. 
3. AI-chat hjælper din tekniske skribent med at forenkle komplekse begreber. Den foreslår alternative forklaringer og identificerer områder, hvor brugerne kan have brug for yderligere kontekst. 

Hvordan AI kan forbedre effektiviteten af teknisk skrivning

Se her, hvordan AI kan hjælpe dig med teknisk skrivning: 

1. Automatisering

Det er svært at starte fra en tom side. Du kan bruge AI til at udarbejde det første indhold baseret på strukturerede data.

Det reducerer den tid, det tager at lave manualer, vejledninger og rapporter. 

Hvordan man gør det...

Brug AI-værktøjer som AI-chatbot til at generere grundlæggende skitser eller endda et første udkast.

Derefter skal du forfine sproget ved at bruge branchespecifik terminologi og faktatjekke indholdet. 

2. Grammatik og klarhed

Brug AI-værktøjer til at tjekke for jargon, passiv stemme og problemer med læsbarheden. 

Sådan bruger du det...

Kør udkast igennem AI-parafraser. Dette værktøj hjælper med at omskrive komplekse sætninger, foreslår klarsprogsalternativer og forbedrer den generelle læsbarhed.

3. Strukturering af indhold

Et velstruktureret dokument forhindrer forvirring.

AI kan organisere indhold logisk ved at gruppere relaterede emner, tilføje overskrifter og foreslå layouts. 

Sådan bruger du den.

Brug vores AI essayforfatter til at skabe rapporter, manualer og dokumentation.

Konklusion

Tekniske skribenter oversætter "ingeniørsprog" til "menneskesprog".

Det er derfor, piloter kan lande fly sikkert uden at læse en manual på 10.000 sider under flyvningen, hvorfor kirurger fokuserer på at redde liv i stedet for at tyde kryptiske instruktioner, og hvorfor du rent faktisk kan bruge den smarte kaffemaskine uden at skabe en utilsigtet gejser i dit køkken. 

I vores komplekse verden er klar kommunikation afgørende.

God teknisk skrivning sparer tid, penge, frustrationer og nogle gange også liv (i medicinske og sikkerhedsmæssige sammenhænge).

I fremtiden vil vi se flere videoer i form af interaktive vejledninger og dokumenter, der tilpasser sig dit ekspertiseniveau. 

Hvis du vil udfolde dine tekniske skrivemuskler, skal du vælge noget kompliceret, som du forstår godt - måske hvordan fotosyntesen fungerer, offside-reglen i fodbold eller endda hvordan man laver den perfekte soufflé - og forklare det til en ven på den klareste og mest enkle måde. 

Hvis de forstår det i stedet for det glasagtige blik, så tillykke!

Du har opdaget den tekniske skribents kernekompetence: at gøre det komplicerede ukompliceret.

Brug for ekstra hjælp? Uopdagelig AI værktøjer forfiner din skrivning og holder den fejlfri. Prøv dem nu!

Du er velkommen til at udforske vores AI-detektor og Humanizer i widgetten nedenfor!