Teknisk skrivning formidler teknisk information om en færdighed eller et produkt til læserne. Det er almindeligt anvendt inden for tekniske og erhvervsmæssige områder. Som teknisk skribent skriver du ofte dokumenter som brugervejledninger, applikationsprogrammeringsgrænseflade (API) dokumentation og reparations- og produktmanualer.
Ligesom andre skrivenicher har teknisk skrivning nichespecifikke retningslinjer. At følge disse retningslinjer vil hjælpe dig med at skrive velstrukturerede dokumenter og optimere, hvordan læserne forstår dit arbejde. Her er nogle regler, du skal følge for at blive en god teknisk forfatter.
1. Definer dit publikum
Publikumsanalyse er en uundværlig faktor i et godt teknisk dokument. At kende dit publikum hjælper dig med at bestemme, hvilken type information du skal skrive om, hvordan du skal strukturere den, og det tekniske ved dit sprog. Der er fire store målgrupper for teknisk skrivning: ledere, eksperter, teknikere og ikke-specialister.
Ledere er personer, der finansierer produktet og træffer de politiske, administrative og økonomiske beslutninger, der styrer det. Teknikere er de mennesker, der bygger, betjener og reparerer disse produkter. Eksperter designer, tester og ved alt om produktet, mens ikke-specialister er slutbrugerne af produkterne. Du skal overveje dit publikum for at bestemme den bedste tone og skrivestil at bruge.
2. Identificer dit publikums behov
Udover at kende og definere dit publikum, er det afgørende, at du forstår deres mål, interesser og behov. At færdiggøre din målgruppeanalyse er nøglen til dokumentforberedelse, da du er mindre tilbøjelig til at skrive uden hikke og kender dit publikums behov godt.
For at udføre en velafrundet publikumsanalyse skal du overveje dit publikums baggrund, eksisterende viden om produktet, oplevelsen, behov, interesser, demografiske karakteristika, kultur og kommunikationspræferencer og mål. Denne information vil hjælpe dig med at præsentere dine ideer mest effektivt og effektivt.
3. Kend grænsen for dit publikums viden
Som en publikumsanalyseteknik kan du bruge undersøgelser og spørgeskemaer til at kende grænsen for dit publikums viden. Du kan også hente populære meninger og stereotyper, personlige erfaringer, brainstorming og publikumsfeedback fra marketingafdelingen.
Hvis du bruger de ovennævnte værktøjer korrekt, vil du vide, hvor meget din målgruppe forstår den information, du har til hensigt at formidle. Disse oplysninger vil i høj grad bestemme dit dokuments struktur, grænser og omfang, hvilket giver dig en følelse af retning.
4. Hold dit sprog simpelt
Teknisk skrivning formodes at præsentere et alt for kompliceret emne. Det gør den ved at bruge en ligetil skrivestilsguide. Du bør sikre dig, at den gennemsnitlige læser nemt kan forstå din skrivning.
Du skal dog bemærke, at forståelse af dit publikum også er nøglen til den sprogstil, du vælger. For eksempel faglig jargon i et dokument om applikationsprogrammeringsgrænseflader (API) kan være passende for teknikere, men ikke slutbrugere. Derfor skal du bruge et letforståeligt sprog for at hjælpe publikums forståelse. Du vil måske også lære hvordan man bruger et værktøj som Microsoft Editor for at tjekke dit arbejde og sikre, at skriften er korrekt.
5. Brug omrids
Skitser giver dine læsere en idé om, hvad de kan forvente i dokumentet. Et dokument uden omrids overvælder læserne, da det tvinger dem til at læse hele teksten, når de kun er interesseret i at tilegne sig specifik viden.
Som teknisk skribent giver skitseringen af dit dokument dig også en følelse af retning, når du skriver. Det holder dig på sporet og sikrer, at du ikke går glip af eller undervurderer relevante point. Derudover forbedrer det strukturen af dit dokument og fungerer som feedback på, hvad du har til hensigt at dække.
6. Brug grafik, hvor det er nødvendigt
De fleste læseres opmærksomhed er naturligt tiltrukket af grafik sammenlignet med tekst. I tekniske dokumenter kan passende grafik forbedre læsernes forståelse af teksten ved at præsentere information klart og eftertrykkeligt.
Men som teknisk skribent skal du passe på ikke at bruge grafik til at dekorere dokumenter. Tabeller, grafer, diagrammer, fotografier og illustrationer er almindeligt anvendte grafikker, og de kan forbedre dokumentets overordnede struktur og appellere til læserne. Når det er sagt, hvis du er ny til Google Docs, her er hvordan man opretter og redigerer tabeller i Google Docs.
7. Engager dine læsere
Selvom du måske forsøger at formidle teknisk information til dine læsere, er det vigtigt, at du også engagerer dem. Ethvert teknisk dokument er læsercentreret og bør skrives efter læserens smag og ikke forfatterens smag. Din læsers intellektuelle nysgerrighed skal tilfredsstilles, for at dit dokument er brugbart.
Du kan aktivt engagere din læser ved at skrive for at udtrykke, ikke imponere og komme direkte til sagen. Undgå forkortelser og jargon, brug meget hvidt mellemrum til at forbedre den visuelle præsentation, og brug overskrifter til at vejlede din læser.
8. Henvis ikke tidsfølsomme oplysninger
Det er altid at foretrække at undgå henvisninger til tidsfølsomme oplysninger, især dem fra en sammenlignelig periode. Det er sikrere og klogere at bruge analyser, der har bestået tidens tand, hvilket gør det stedsegrønt og altid egnet til dem, der vil læse dit dokument i fremtiden.
Du skal også bemærke, at vedhæftning af bestemte årstal, som "2019", for at understrege din pointe, kan reducere anvendeligheden af dit dokument over tid, undtagen i specifikke tilfælde. Du kan forhindre dette ved at bruge en bredere tidsramme som "I de sidste syv år", og dermed give dit arbejde et niveau af troværdighed.
9. Brug relevante eksempler
Når du skriver et teknisk dokument, skal du bruge live-instanser til at understrege dine pointer. Da dit publikum læser din skrivning for at erhverve en færdighed, løse et problem eller lære nogle retningslinjer, skal du give dem praktiske og relaterbare eksempler.
Disse eksempler forbedrer dit arbejdes læsbarhed og kommunikerer kompleks information til din læser, hvilket giver kontekst til produkter og processer. På denne måde er der større sandsynlighed for, at de bruger produkterne bevidst og sikkert.
10. Få en tredjepartsgennemgang, før du udgiver
Et teknisk dokument skal altid gennemgå en samarbejdsproces, der involverer forfatteren og anmelderen. En tredjepartsgennemgang hjælper med at generere et publikumsfokuseret, fejlfrit og effektfuldt dokument.
Som dokumentets oprindelige forfatter har du muligvis skrevet mange udkast, før du oprettede det endelige dokument. Ikke desto mindre, uanset hvor godt dit dokument fremstår, skal du ikke være afhængig af din forstand alene.
Bliv en professionel teknisk skribent i dag
Forståelse af de væsentlige regler for teknisk skrivning vil gøre dig mere dygtig og meget eftertragtet. Mange organisationer ved, hvor vigtigt det er, at deres produkter eller tjenester bliver markedsført godt til slutbrugere, og at hjælpe dem med at opnå dette er dit mål som teknisk skribent.
