Teknisk skrivning er mere end blot at skrive manualer om, hvordan du bruger eller reparerer dit tv. Det omfatter forskellige typer dokumenter, selv markedsføringsdokumenter. Læs denne artikel for at lære mere om teknisk dokumentation; den vil være nyttig for nybegyndere inden for teknisk skrivning, som ønsker at afgøre, hvilken type dokumentation der vil være interessant.

Brugervejledninger, manualer, “How to”-vejledninger og lignende er de mest almindelige typer af teknisk dokumentation, og det er dem, som folk altid kommer til at tænke på, når nogen siger “teknisk dokumentation”. Lad mig beskrive nogle typer i detaljer.

Brugervejledninger

Brugervejledninger hjælper folk med at bruge et bestemt system som f.eks. et stykke hardware eller software. De giver klare og fornuftige oplysninger om almindelige spørgsmål, som brugerne kan stå over for. Brugervejledninger kan også indeholde oplysninger om mulige fejlfunktioner og måder at løse dem på. Et eksempel er en onlinehjælp til ClickHelp. Den beskriver funktioner, muligheder og brugssituationer for dette softwaredokumentationsværktøj.

Produktmanualer

Produktmanualer oprettes for at beskrive et produkts grundlæggende funktioner, dets vigtigste funktioner, generel vedligeholdelse og meget mere. Her er et eksempel – en side fra en manual til et armbåndsur:

API-dokumentation

Tekniske skribenter opretter API-dokumentation, hvor de beskriver instruktioner om, hvordan man effektivt bruger hardware (SCPI’er), web-API eller software-API. Normalt indeholder API-dokumentation alle de oplysninger, der er nødvendige for at arbejde med API’et, detaljer om klasser, funktioner, argumenter og lignende, understøttet af eksempler og tutorials.

API-dokumentation har til formål at hjælpe klienter eller brugere med at implementere API’et og forstå, hvordan det fungerer. Denne type dokumentation hjælper f.eks. virksomheder med at gøre det lettere for brugerne at interagere med koden.

For at lære mere om API-dokumentation kan du læse denne artikel:

Science Papers, Research, and Reports

Tekniske skribenter arbejder også sammen med fagfolk fra andre områder som medicin, videnskab, luft- og rumfart, ingeniørvidenskab osv.

Som vi taler om videnskab og medicin, skriver forskere papirer med resultaterne af deres arbejde, men disse resultater kan være svære at forklare for det brede publikum, så forfatterne beder tekniske skribenter om at hjælpe dem med at fortolke og organisere resultaterne. Disse offentliggøres i tidsskrifter, og derfor er nøjagtighed og organisering af indholdet meget vigtigt – og tekniske skribenter er de bedste til dette job.

Tekniske skribenter hjælper også virksomhedsejere med at hjælpe dem med at udarbejde rapporter, fordi der også kræves klarhed og nøjagtighed af indholdet.

Teknisk markedsføringsdokumentation

Teknisk skrivning omfatter også markedsføringsindhold.Tekniske skribenter kan skabe letfortolkede og præcise artikler, som hjælper kunderne med at forstå, hvordan et produkt skal betjenes korrekt. Hvidbøger, casestudier, forslag er eksempler på teknisk markedsføringsdokumentation.

White Papers

De vigtigste mål med en hvidbog er at fremhæve en virksomheds succes og bidrage til at fremme virksomhedens produkter eller tjenester. Som et markedsføringsværktøj indsamler white papers oplysninger om fakta og logiske argumenter for, hvorfor denne virksomhed og dens produkt er det bedste. White papers fokuserer normalt på nye løsninger på et gammelt problem eller på fordelene ved et B2B-produkt eller en B2B-tjeneste.

Case Study

En case study er en analyse af en virksomhed, et produkt eller et projekt, der identificerer en løsning eller en situation, der har bidraget til fiasko eller succes. Casestudier giver potentielle købere mulighed for at se dit produkt i praksis. De fokuserer på en kundes oplevelse for at vise, hvordan et bestemt produkt eller en tjeneste kan hjælpe dig og din virksomhed.

Proposals

Tekniske skribenter udarbejder også forslag til B2B-virksomheder. Tekniske skribenter hjælper med at overtale læseren til at godkende et foreslået projekt eller gennemføre en foreslået plan. Den kan indeholde anbefalinger, resultater af undersøgelser, teknisk baggrund, oplysninger om gennemførlighed osv.

Der findes naturligvis andre typer og andre klassifikationer af teknisk dokumentation. I ClickHelp-bloggen er dokumentationstyperne f.eks. opdelt efter læsere, brancher m.m. Du kan få mere at vide her: ‘Typer af tekniske dokumenter’.