Teori

Hva er en teknisk forfatter?

En teknisk forfatter (Engelsk: Technical Writer eller Technical Author) er en yrkestittel som brukes om personer som har som sine viktigste oppgaver å planlegge, utvikle, organisere, skrive, publisere og vedlikeholde teknisk dokumentasjon og bruksanvisninger.

Se også:


Hva er teknisk dokumentasjon?

Uttrykket teknisk dokumentasjon brukes som en samlebegrep om en rekke dokumenttyper som inneholder informasjon om hvordan et produkt er utviklet, og hvordan det skal produseres, testes og vedlikeholdes. Som tekniske dokumenter regnes således både tegninger, fotografier, prosedyrer, spesifikasjoner or tilsvarende informasjon på en rekke ulike formater som brukes til de gitte formålene.

Uttrykket teknisk dokumentasjon brukes også som et felles begrep for alle typer tekniske manualer. Dette inkluderer alle slags dokumentasjon fra produsent til sluttbruker eller forhandler som forklarer hvordan en gitt produkt skal installeres, brukes og vedlikeholdes. Den delen av den tekniske dokumentasjonen som beskriver hvordan et produkt skal brukes kalles ofte en bruksanvisning.

| Toppen av siden |

Bruksanvisninger

Tekniske forfattere spiller en viktig rolle i produksjonsbedrifter, og spesielt i de bedriftene som lager tekniske produkter for profesjonelt eller alment bruk. Produktet kan være en barbermaskin, en DVD-opptaker eller en truck, uansett er det nødvendig med en bruksanvisning som forklarer brukeren hvordan produktet skal benyttes riktig, sikkert og effektivt. En slik bruksanvisning kan således være stor og omfattende, eller kanskje ganske liten - dette avhenger av produktets kompleksitet. Barbermaskinen er muligens enkel å bruke, mens DVD-opptakeren tilbyr en rekke avanserte funksjoner som krever detaljerte forklaringer. Trucken er kanskje fysisk større, men der settes det krav til sertifisering hos vedkommende som skal kjøre den.

Utformingen av bruksanvisninger er forøvrig beskrevet i en rekke nasjonale og internasjonale standarder. Disse standardene setter spesielt krav til innhold, men også i en viss grad til organisering og utførelse.

Toppen av siden

On-line hjelp

For de fleste som utarbeider dataprogrammer er on-line hjelp en viktig funksjon. Mange foretrekker å la programvareutviklerne skrive hjelpetekstene, mens andre mener at de som utvikler programvare heller skal konsentrere seg om det, og la en teknisk forfatter også skrive produktets on-line hjelp. Ved bruk av riktig verktøy kan forfatterens hjelpetekster utgjøre en effektivt kontekst sensitiv hjelpefunksjon, og samtidig automatisk publiseres til PDF i bokformat (såkalt "parallellpublisering"). Således slipper produsenten at flere personer i organisasjonen bruker tid til å skrive om de samme emnene.

| Toppen av siden |

Tekniske manualer

Tekniske manualer omfatter normalt all nødvendig informasjon om installasjon, igangsettelse og vedlikehold av produktet. Her må produsenten først definere hvem som skal utføre disse oppgavene, og dernest utarbeide håndbøkene for denne målgruppen. Når du kjøper en vaskemaskin får du gjerne med et lite hefte som forklarer hvordan maskinen skal settes på plass, og hvilke brytere du skal trykke på for å vaske sokkene dine. Du får derimot ikke noen bok som forklarer hvordan du skal reparere vaskemaskinen hvis den går i stykker. Den manualen går kun til forhandleren og autoriserte reparatører. På samme måte får du kun et lite hefte som forklarer hvordan du skal bruke bilen din - bilens produsent forutsetter jo at du har sertifikat - mens den omfattende dokumentasjonen som gjelder reparasjon kun går til forhandleren og bilverkstedet.

Som teknisk forfatter hos produsenten er det du som utarbeider alle disse manualene, dog i nært samarbeide med produktutviklere og andre eksperter. Din oppgave er å samle informasjonen, gjøre den konsistent og helhetlig, sammen med produktsjef sortere hvilken informasjon som må være med i manualene, og dernest organisere og utarbeide nødvendig tekst og tegninger.

| Toppen av siden |

Verktøy for tekniske forfattere

Tekniske forfattere benytter seg normalt av avanserte verktøy for tekstbehandling, publisering, illustrering og bildebehandling. Standard verktøy for kontorstøtte vil i liten grad tilby den funksjonaliteten som er ønskelig. Typiske verktøy er således Adobe FrameMaker, BroadVision Quicksilver (tidligere "Interleaf") og forskjellige XML editorer. Det finnes også en rekke andre spesialiserte verktøy på markedet.

| Toppen av siden |

Relaterte lenker

Disse lenkene åpner nye vinduer i nettleseren din. Se forøvrig Generell informasjon om lenker.

| Toppen av siden |

Valid XHTML 1.0 Transitional