Teknisk skriving formidler teknisk informasjon om en ferdighet eller et produkt til leserne. Det er ofte brukt i tekniske og yrkesmessige felt. Som teknisk skribent skriver du ofte dokumenter som brukerveiledninger, dokumentasjon for applikasjonsprogrammeringsgrensesnitt (API) og reparasjons- og produktmanualer.
Som andre skrivenisjer har teknisk skriving nisjespesifikke retningslinjer. Å følge disse retningslinjene vil hjelpe deg med å skrive velstrukturerte dokumenter og optimalisere hvordan leserne forstår arbeidet ditt. Her er noen regler du må følge for å bli en god teknisk forfatter.
1. Definer målgruppen din
Publikumsanalyse er en uunnværlig faktor i et godt teknisk dokument. Å kjenne publikummet ditt hjelper deg med å finne ut hva slags informasjon du skal skrive om, hvordan du bør strukturere den og det tekniske i språket ditt. Det er fire hovedmålgrupper for teknisk skriving: ledere, eksperter, teknikere og ikke-spesialister.
Ledere er individer som finansierer produktet og tar de politiske, administrative og økonomiske beslutningene som styrer det. Teknikere er menneskene som bygger, betjener og reparerer disse produktene. Eksperter designer, tester og vet alt om produktet, mens ikke-spesialister er sluttbrukerne av produktene. Du må vurdere publikum for å finne den beste tonen og skrivestilen å bruke.
2. Identifiser målgruppens behov
Bortsett fra å kjenne og definere publikummet ditt, er det avgjørende at du forstår deres mål, interesser og behov. Å fullføre publikumsanalysen er nøkkelen i dokumentforberedelsen, siden det er mindre sannsynlig at du skriver uten hikke og kjenner publikums behov godt.
For å gjennomføre en godt avrundet publikumsanalyse må du vurdere publikums bakgrunn, eksisterende kunnskap om produktet, erfaring, behov, interesser, demografiske egenskaper, kultur og kommunikasjonspreferanser, og mål. Denne informasjonen vil hjelpe deg med å presentere ideene dine mest effektivt og effektivt.
3. Kjenn grensen for publikums kunnskap
Som en publikumsanalyseteknikk kan du bruke undersøkelser og spørreskjemaer for å kjenne grensen for publikums kunnskap. Du kan også hente populære meninger og stereotyper, personlig erfaring, idédugnad og tilbakemeldinger fra publikum, fra markedsavdelingen.
Hvis du bruker verktøyene ovenfor på riktig måte, vil du vite hvor mye målgruppen din forstår informasjonen du har tenkt å formidle. Denne informasjonen vil i stor grad bestemme dokumentets struktur, begrensninger og omfang, og gi deg en følelse av retning.
4. Hold språket ditt enkelt
Teknisk skriving er ment å presentere et altfor komplisert emne. Den gjør dette ved å bruke en enkel skrivestilguide. Du bør sørge for at den gjennomsnittlige leseren lett kan forstå det du skriver.
Du må imidlertid merke deg at det å forstå publikummet ditt også er nøkkelen til språkstilen du velger. For eksempel fagsjargong i et dokument om applikasjonsprogrammeringsgrensesnitt (API) kan være passende for teknikere, men ikke sluttbrukere. Følgelig må du bruke et lettfattelig språk for å hjelpe publikums forståelse. Det kan også være lurt å lære hvordan du bruker et verktøy som Microsoft Editor for å sjekke arbeidet ditt og sikre at skriften er riktig.
5. Bruk konturer
Skisser gir leserne en ide om hva de kan forvente i dokumentet. Et dokument uten omriss overvelder leserne, siden det tvinger dem til å lese hele teksten når de kun er interessert i å tilegne seg spesifikk kunnskap.
Som teknisk skribent gir det å skissere dokumentet deg også en følelse av retning når du skriver. Det holder deg på sporet og sikrer at du ikke går glipp av eller undervurderer relevante poeng. I tillegg forbedrer det strukturen til dokumentet ditt og fungerer som tilbakemelding på hva du har tenkt å dekke.
6. Bruk grafikk der det er nødvendig
De fleste leseres oppmerksomhet trekkes naturlig mot grafikk sammenlignet med tekst. I tekniske dokumenter kan egnet grafikk forbedre lesernes forståelse av teksten ved å presentere informasjon klart og ettertrykkelig.
Men som teknisk skribent bør du være forsiktig med å bruke grafikk til å dekorere dokumenter. Tabeller, grafer, diagrammer, fotografier og illustrasjoner er ofte brukte grafikk, og de kan forbedre dokumentets generelle struktur og appellere til leserne. Når det er sagt, hvis du er ny på Google Dokumenter, her er hvordan du oppretter og redigerer tabeller i Google Dokumenter.
7. Engasjer leserne dine
Selv om du kanskje prøver å formidle teknisk informasjon til leserne dine, er det viktig at du også engasjerer dem. Hvert teknisk dokument er lesersentrert og bør skrives etter leserens smak og ikke forfatterens. Leserens intellektuelle nysgjerrighet må tilfredsstilles for at dokumentet ditt skal være nyttig.
Du kan aktivt engasjere leseren din ved å skrive for å uttrykke, ikke imponere, og komme rett til poenget. Unngå forkortelser og sjargong, bruk mye mellomrom for å forbedre den visuelle presentasjonen, og bruk overskrifter for å veilede leseren.
8. Ikke referer til tidssensitiv informasjon
Det er alltid å foretrekke å unngå referanser til tidssensitiv informasjon, spesielt for en sammenlignbar periode. Det er tryggere og klokere å bruke analyser som har tålt tidens tann, noe som gjør den eviggrønn og alltid egnet for de som skal lese dokumentet ditt i fremtiden.
Du må også merke deg at ved å legge ved bestemte år, som "2019", for å understreke poenget ditt, kan det redusere nytten av dokumentet ditt over tid, bortsett fra i spesifikke tilfeller. Du kan forhindre dette ved å bruke en bredere tidsramme som "I de siste syv årene," og dermed gi arbeidet ditt et nivå av troverdighet.
9. Bruk relevante eksempler
Når du skriver et teknisk dokument, bruk live-instanser for å understreke poengene dine. Siden publikum leser det du skriver for å tilegne seg en ferdighet, løse et problem eller lære noen retningslinjer, må du gi dem praktiske og relaterte eksempler.
Disse eksemplene forbedrer arbeidets lesbarhet og kommuniserer kompleks informasjon til leseren, og gir kontekst til produkter og prosesser. På denne måten er det mer sannsynlig at de bruker produktene bevisst og trygt.
10. Få en tredjeparts anmeldelse før publisering
Et teknisk dokument skal alltid gå gjennom en samarbeidsprosess som involverer forfatteren og anmelderen. En tredjeparts anmeldelse bidrar til å generere et publikumsfokusert, feilfritt og effektfullt dokument.
Som dokumentets opprinnelige forfatter kan du ha skrevet mange utkast før du opprettet det endelige dokumentet. Uansett hvor godt dokumentet ditt fremstår, ikke avhengig av vettet ditt alene.
Bli en profesjonell teknisk skribent i dag
Å forstå de grunnleggende reglene for teknisk skriving vil gjøre deg mer dyktig og ettertraktet. Mange organisasjoner vet hvor viktig det er for deres produkter eller tjenester å bli godt markedsført til sluttbrukere, og å hjelpe dem med å oppnå dette er målet ditt som teknisk skribent.