Hva er teknisk skriving? En komplett guide

Når du sliter med en ny gadget, strekker du deg etter bruksanvisningen.

Når du står fast med å konfigurere programvare, kan du sjekke hjelpesidene.

Når bilen din lager en merkelig lyd, blar du i manualen i hanskerommet.

Alle disse er eksempler på teknisk skriving - noe vi er avhengige av hver dag, men sjelden tenker over.

Ifølge Glassdoor tjener en teknisk skribent hos SpaceX mellom $88 000 til $138 000 per år. 

Likevel er det fortsatt mange som ikke forstår hva teknisk skriving egentlig er.

Det er ikke bare skrive opp instruksjoner.

Det er ikke bare oversette ingeniørspråk til vanlig engelsk.

Og det er ikke engang bare skape brukerhåndbøker eller hjelpedokumenter. 

Så hva er teknisk skriving? Hvordan skiller det seg fra andre typer skriving? Hva er de ulike formene? Hvordan kan du bli teknisk skribent? Og hvordan kan AI hjelpe deg på veien? 

Alt dette - og mye mer - tar vi for oss i denne bloggen. La oss dykke ned i det! 

Hva er teknisk skriving?

I lekmannsspråk betyr teknisk skriving å ta vanskelige og detaljerte emner og forklare dem på en måte som alle (med riktig bakgrunn) kan følge med på. 

For eksempel, dette inkluderer:

• Brukerhåndbøker - Heftet som fulgte med telefonen din? Det er teknisk skriving.
• API-dokumentasjon - Utviklere trenger også instruksjoner. API-er forklarer ikke seg selv.
• Tekniske rapporter - Ingeniører og forskere er avhengige av disse for å dele forskning og funn.

Teknisk skriving er ikke bare hva du skriver, men hvordan du skriver det. Den bruker:

• Imperativ - I stedet for "Du bør klikke på knappen." det er bare "Klikk på knappen." 

• Passiv stemme (når det er nødvendig) - -. Hvis det ikke spiller noen rolle hvem som utførte handlingen, hjelper passiv stemme. "Filen ble slettet" fungerer bedre enn "Noen har slettet filen" hvis fokuset er på filen.

Noen tror at teknisk skriving bare handler om å skrive for SaaS-produkter eller tekniske blogger. 

Men det handler ikke om markedsføring eller historiefortelling. 

Teknisk skriving har svært forskjellige typer (vi kommer tilbake til dette om litt) - alle med samme formål: å presentere informasjonen på en nøyaktig, tydelig og funksjonell måte. 

Hvordan teknisk skriving skiller seg fra andre skrivestiler

La oss se nærmere på seks aspekter som skiller teknisk skriving fra andre skrivestiler.

Kreative forfattere bruker tvetydighet eller metaforer for å skape en engasjerende faktor for publikum. 

Tekniske skribenter tar ikke sikte på tvetydighet. 

De ønsker å prioritere klarhet fremfor kreativt uttrykk, men det ligger i arbeidets natur. 

Hvorfor teknisk skriving er viktig i ulike bransjer

Forestill deg en pilot som leser denne håndboken midt under flyturen når han eller hun trenger å forstå noe som haster:

"Juster skyvekraftvektoren for å kompensere for asymmetrisk fremdriftsanomali ved å implementere standardavviksprotokoll 5.3b med hensyn til atmosfæriske tetthetsvariabler"

Eller tenk deg en kirurg som går gjennom retningslinjene for prosedyren like før en kritisk operasjon: 

"Skjær parallelt med fasciale plan med hensyn til underliggende nevrovaskulære strukturer, samtidig som hemostase opprettholdes gjennom hele disseksjonssekvensen." 

Selv om de er leger eller piloter som har studert dette hele karrieren, vil de ikke ønske å lese dette i en nødsituasjon. 

Det skaper forvirring og frustrasjon, noe alle ønsker å unngå uansett situasjon.

La oss ta en titt på fem viktige grunner til at teknisk skriving er et absolutt must: 

1. Risikoreduksjon og etterlevelse - I bransjer som helse, finans og luftfart er feil ikke bare kostbare - de kan også være dødelige. 
   • For eksempel, Hva om en sykepleier feiltolker doseringsinstruksjonene på grunn av uklare formuleringer? Riktig dokumentasjon forhindrer slike feil. 

2. Bevaring og overføring av kunnskap - Folk slutter i jobben, blir forfremmet eller går av med pensjon. Men hva skjer med all kunnskapen de har i hodet? De dokumenteres på riktig måte ved hjelp av teknisk skriving. En veldokumentert prosess betyr at neste person kan ta over uten å måtte starte helt fra bunnen av.

3. Kundetilfredshet og reduserte supportkostnader - Har du noen gang prøvd å konfigurere en ny enhet og endt opp med å se en tilfeldig YouTube-veiledning fordi manualen ikke ga noen mening? Dårlig dokumentasjon frustrerer kundene og belaster kundestøtteteamene med unødvendige samtaler. Med en velskrevet veiledning slipper du alt dette. 

4. Juridisk beskyttelse - Kontrakter, retningslinjer og sikkerhetsanvisninger brukes som bevis i tvister.
   • For eksempel, Hvis et selskap blir saksøkt for et defekt produkt, er det første advokatene sjekker dokumentasjonen. Inneholdt bruksanvisningen advarsler om risiko? Var sikkerhetsprosedyrene tydelig beskrevet? Hvis ikke, er selskapet i trøbbel.

5. Effektivitetsgevinster gjennom standardisering - Forestill deg et selskap der hver avdeling bruker ulike systemer for de samme oppgavene. Ett team sporer data i regneark, et annet bruker tilpasset programvare, mens et tredje bare "husker ting". Det er et eneste rot. Teknisk skriving sørger for at prosessene er standardiserte, repeterbare og skalerbare

I bunn og grunn bidrar teknisk skriving til å forhindre forvirring, spare tid og holde folk trygge. 

Typer teknisk skriving (med eksempler)

Mange mennesker hører "teknisk skriving" og tenker umiddelbart på tørre, robotaktige brukermanualer - slike som ingen faktisk leser med mindre de sitter helt fast. 

Men teknisk skriving er mye mer enn det. 

I virkeligheten finnes det i nesten alle bransjer, og det finnes i mange ulike former som alle tjener et bestemt formål.

Her er de seks viktigste typene teknisk skriving (med eksempler):

1. Teknisk dokumentasjon - Dette er den klassiske typen. Den inneholder brukerhåndbøker, produktveiledninger og feilsøkingsinstruksjoner.  
   • For eksempel, Du har nettopp kjøpt en splitter ny espressomaskin, og du er forvirret over de mange knappene. I stedet for å gjette, blar du opp bruksanvisningen og følger trinn-for-trinn-veiledningen for å lage din første kopp.
     
2. Prosessdokumentasjon - Alle selskaper har arbeidsflyter, men hvis disse arbeidsflytene bare eksisterer i noens hode, er det en katastrofe som venter på å skje. Disse kalles SOP-er. 
   • For eksempel, Du må lage et bakeris signatursurdeig. Uten en SOP ville hvert brød vært forskjellig. Heldigvis beskriver SOP-en hvert trinn i detalj - nøyaktige mål, hevetider, steketemperaturer - hver gang.
     
3. API-dokumentasjon - Hvis programvare er hjernen, API-er (Application Programming Interfaces) er nervesystemet. 
   • For eksempel, En samkjøringsapp ønsker trafikkdata i sanntid, så den integrerer Google Maps' API. Uten tydelige API-dokumenter ville de måtte prøve og feile i det uendelige.
     
4. Vitenskapelige artikler/forskningsartikler - Disse er skrevet av forskere, men må kunne leses av resten av verden.  
   • For eksempelEn ny kreftbehandling ser lovende ut, men før den tas i bruk, må forskerne publisere forskning om hvordan den virker, bivirkninger og overlevelsesrater. Andre går gjennom dataene for å verifisere dem.
     
5. Hvitebøker og casestudier - White papers er de "overbevisende argumentene" i den tekniske verden. Casestudier går enda lenger, og viser suksesshistorier fra den virkelige verden med faktiske resultater. 
   • For eksempel, Et cybersikkerhetsfirma advarer mot en ny banktrussel i en hvitbok. En måned senere delte de en casestudie om hvordan verktøyet deres stoppet et angrep. Bankene begynner å følge med.
     
6. Dokumentasjon av regelverk/overensstemmelse - Helsevesen, finans og produksjon er avhengige av regelverk. Compliance-dokumenter hjelper bedrifter med å følge lovene, slik at de unngår bøter, søksmål og offentlige katastrofer.
   • For eksempel, Et legemiddelfirma må bevise at et nytt smertestillende middel er trygt før det kan selges. De sender inn dokumenter som viser ingredienser, dosering og bivirkninger for å unngå juridiske problemer.

Nøkkelferdigheter som kreves for teknisk skriving

Hvis du noen gang har lært besteforeldrene dine å bruke en smarttelefon uten å få dem til å føle seg dumme, kan du bli teknisk skribent, for dette er kjernekompetansen.

Alle andre ferdigheter kan læres. Her er en liste over ferdigheter en teknisk skribent må ha:

• Forskningsevner - Du trenger ikke å vite alt, men du må vite hvordan du finner nøyaktig og pålitelig informasjon.
  
• Publikumsanalyse - Det som gjør teksten nyttig, er at du vet hvem leserne dine er, hva de allerede vet og hva de har behov for å oppnå. For måten du forklarer en programvareoppdatering til en utvikler på, er ikke den samme som du forklarer den til en kunde.
  
• Tydelig kommunikasjon/klare språkferdigheter - Teknisk skriving handler ikke om å høres smart ut - det handler om å få andre til å føle seg smarte. Det betyr at du må fjerne sjargong, bruke et enkelt språk og skrive så klart og tydelig at leseren aldri trenger å gjette hva du mener.
  
• Informasjonsarkitektur - Leserne leser ikke alltid fra start til slutt, de skanner. Du må forstå hvordan du organiserer innholdet med overskrifter, kulepunkter og logisk flyt, slik at informasjonen er lett å finne og fordøye.
  
• Visuell kommunikasjon - Noen ganger forklarer et bilde noe raskere enn et avsnitt. Flytskjemaer, kommenterte skjermbilder og infografikk kan forenkle selv de mest forvirrende konsepter. En god teknisk skribent vet når han eller hun skal skrive og når han eller hun skal vise.
  
• Verktøykompetanse - Å kjenne til de riktige verktøyene gjør prosessen raskere. For eksempel kan MadCap Flare eller Confluence være gode dokumentasjonsverktøy, mens Snagit eller Figma er gode designverktøy.

• Redigerings- og revisjonsferdigheter-Det første utkastet er aldri perfekt. Tekniske skribenter må finpusse arbeidet for å sikre klarhet, nøyaktighet og fullstendighet, og sørge for at hvert ord tjener et formål. Dette handler om å gjøre dokumentet så brukervennlig som mulig.

Hvem bruker teknisk skriving? (bransjer som trenger det)

Her er de fire bransjene som har størst behov for teknisk skriving.

Hvordan bli teknisk skribent 

Her er en trinnvis veiledning for å komme inn på dette feltet:

Trinn # 1 - Lær deg det grunnleggende

Du trenger ikke å ha en utdannelse innen kommunikasjon eller engelsk for å komme i gang.

Du kan gå inn i og trives i denne karrieren selv om du er lærer, journalist, ingeniør eller til og med kommer fra det medisinske feltet.

Ta nybegynnervennlige kurs og sertifiseringer på Coursera, Udemy, eller Googles kurs i teknisk skriving. 

Følg bransjeblogger som  Skriv dokumentene og STC (Society for Technical Communication).

Trinn # 2 - Bygg opp en portefølje

Velg et produkt du bruker daglig (f.eks. en kaffetrakter, en treningsapp eller en smarthøyttaler), og skriv en brukerhåndbok eller feilsøkingsveiledning. 

Ville det vært perfekt? Nei, det ville det ikke. 

Ville det gitt deg noe konkret å vise til? Absolutt. 

Åpen kildekode-fellesskapet som GitHub er åpen for nye tekniske skribenter. 

Mange prosjekter trenger sårt hjelp med dokumentasjon, og de bryr seg ikke om du er ny. 

Trinn # 3 - Få en rolle på inngangsnivå

Fokuser på stillinger med "junior" eller "associate" i tittelen på plattformer som LinkedIn, Det er sant, og Vi jobber eksternt. 

Ikke overse kontraktstillinger heller - de er ofte lettere å få og kan føre til faste stillinger.

Trinn # 4 - Utvikle karrieren din

Når du har selvtillit og erfaring, kan du sikte mot en stilling som senior teknisk skribent, API-skribent eller UX-skribent.

Gjør deg kjent med verktøy som MadCap Flare, og Oxygen XML for strukturert skriving eller Markdown og Git hvis du vil jobbe med utviklere. Men du trenger ikke å beherske alt på en gang.

Trinn # 5 - Forbered deg til intervjuer

• Vanlige spørsmål er blant annet
  • Hvordan forenkler du et komplekst tema? → Vis et før-og-etter-eksempel.
  • Hvilke verktøy har du brukt? Nevn alle sammen.
  • Hvordan håndterer du tilbakemeldinger fra ingeniører? → Gi et reelt eller hypotetisk eksempel. 

Trinn # 6 - Fortsett å lære og gå opp i nivå

Feltet er i stadig utvikling. Det ene året snakker alle om wikier, det neste handler alt om dokumenter som kode. 

De som trives, er de som fortsetter å oppgradere sin kompetanse. 

Følg TechWhirl og Kirsebærblad for trender.

Begynn i dag. Skriv om produkthåndboken, del den på LinkedIn og be om tilbakemeldinger.

Verktøy og programvare for teknisk skriving

AI-verktøy gjør arbeidsoppgavene enklere og mer effektive - og teknisk skriving er ikke noe unntak.

Her er de tekniske skriveverktøyene som brukes av fagfolk:

1. For utarbeidelse og redigering av innhold:

1. MS Word lar deg lage profesjonelt formaterte dokumenter med nøyaktig kontroll over stiler, overskrifter og kryssreferanser. 
2. Google Dokumenter gjør det mulig for flere teammedlemmer å jobbe samtidig på samme dokument. 

2. For strukturert dokumentasjon og publisering: 

1. MadCap Flare lar deg vedlikeholde én enkelt kilde til innhold som automatisk publiseres i ulike formater. 
2. Adobe FrameMaker håndterer din 500 sider lange tekniske spesifikasjon med komplekse tabeller, spesialiserte diagrammer og kryssreferanser. 

3. For teambasert dokumentasjon:

1. Konfluens blir bedriftens interne wiki der ulike avdelinger vedlikeholder dokumentasjonen sin. 
2. Forestilling hjelper produktteamet ditt med å organisere dokumentasjonen parallelt med prosjektstyringen. 

4. For håndtering og sporing av dokumentendringer:

1. GitHub gjør det mulig for utviklere å oppdatere dokumentasjonen samtidig som koden endres.
2. BitBucket integreres med CI/CD-pipelinen din, slik at dokumentasjonen automatisk bygges og distribueres med hver utgivelse.

5. For forskning, innholdsstruktur og bedre lesbarhet:

1. Essayforfatter hjelper deg med å dokumentere en sofistikert algoritme i passende kontekst, med forklaringer og eksempler. 
2. SEO-forfatter sikrer at dokumentasjonen som henvender seg til publikum, bruker konsekvent terminologi og følger beste praksis for lesbarhet. 
3. AI-chat hjelper den tekniske skribenten med å forenkle komplekse konsepter. Den foreslår alternative forklaringer og identifiserer områder der brukerne kan ha behov for ytterligere kontekst. 

Hvordan AI kan forbedre effektiviteten i teknisk skriving

Slik kan AI hjelpe deg med teknisk skriving: 

1. Automatisering

Det er vanskelig å starte fra en tom side. Du kan bruke kunstig intelligens til å utarbeide det første innholdet basert på strukturerte data.

Det reduserer tiden som trengs for å lage håndbøker, veiledninger og rapporter. 

Hvordan man gjør det...

Bruk AI-verktøy som AI Chatbot til å lage grunnleggende skisser eller til og med et første utkast.

Deretter kan du finpusse språket ved å bruke bransjespesifikk terminologi og faktasjekke innholdet. 

2. Grammatikk og klarhet

Bruk AI-verktøy for å se etter sjargong, passiv stemme og problemer med lesbarheten. 

Slik bruker du den...

Kjør utkast gjennom AI Paraphraser. Dette verktøyet hjelper deg med å omskrive komplekse setninger, foreslår klarspråkalternativer og forbedrer den generelle lesbarheten.

3. Strukturering av innhold

Et godt strukturert dokument forhindrer forvirring.

AI kan organisere innholdet logisk ved å gruppere relaterte emner, legge til overskrifter og foreslå oppsett. 

Slik bruker du den...

Bruk vår AI Essay Writer for å lage rapporter, håndbøker og dokumentasjon.

Konklusjon

Tekniske skribenter oversetter "ingeniørspråk" til "menneskespråk".

Det er derfor piloter kan lande fly trygt uten å lese en 10 000 sider lang manual midt i flyturen, det er derfor kirurger fokuserer på å redde liv i stedet for å tyde kryptiske instruksjoner, og det er derfor du faktisk kan bruke den fancy kaffetrakteren uten å skape en utilsiktet geysir på kjøkkenet. 

I vår komplekse verden er tydelig kommunikasjon helt avgjørende.

God teknisk skriving sparer tid, penger, frustrasjon og noen ganger også liv (i medisinske og sikkerhetsmessige sammenhenger).

I fremtiden vil vi se flere videoer i form av interaktive guider og dokumenter som tilpasser seg ditt kompetansenivå. 

Hvis du vil vise dine tekniske skrivemuskler, kan du velge noe komplisert du forstår godt - kanskje hvordan fotosyntesen fungerer, offsideregelen i fotball eller til og med hvordan du lager den perfekte suffléen - og forklare det til en venn på en så klar og enkel måte som mulig. 

Hvis de forstår det i stedet for å se så glassaktige ut, gratulerer!

Du har oppdaget den tekniske skribentens kjernekompetanse: å gjøre det kompliserte ukomplisert.

Trenger du ekstra hjelp? Ikke påvisbar AI verktøy som forbedrer skrivingen din og gjør den feilfri. Prøv dem nå!

Du er velkommen til å utforske vår AI-detektor og Humanizer i widgeten nedenfor!