Skriftlig InfoOm Skriftlig InfoHva er en teknisk forfatter?

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. I senere tid er tittelen informasjonsutvikler (Information developer) tatt i bruk, da denne er mer dekkende for de allsidige oppgavene som utføres.

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 og tilsvarende informasjon. Dokumentene publiseres på en rekke ulike formater tilpasset de gitte formålene.

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.

Bruksanvisning

Uttrykket bruksanvisning brukes for å beskrive et dokument som er utarbeidet av produsent med det formål å forklare sluttbruker hvordan et gitt produkt skal brukes. En bruksanvisning kan publiseres på en rekke formater tilpasset leserens situasjon og behov. Programvare leveres ofte med kontekt sensitiv on-line hjelp, hvor bruksanvisningen er publisert på et interaktivt format.

En bruksanvisning kan være stor og omfattende, eller ganske liten. Dette avhenger av produktets kompleksitet. En barbermaskin er enkel å bruke, mens en DVD-opptaker tilbyr en rekke avanserte funksjoner som krever detaljerte forklaringer. Trucken er fysisk større, men der settes det krav til sertifisering hos vedkommende som skal kjøre den. Vedlikehold av en truck kan også forutsette at leseren har spesiell utdanning.

Utformingen av bruksanvisninger er 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.

On-line hjelp

For de fleste som utarbeider dataprogrammer er on-line hjelp en viktig funksjon. Mange produsenter 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"). På denne måten slipper produsenten at flere personer i organisasjonen bruker tid til å skrive om de samme emnene.

Tekniske manualer

Tekniske manualer omfatter normalt all nødvendig informasjon om installasjon, igangsettelse og vedlikehold av produktet.

Teknisk manual

Uttrykket teknisk manual brukes for å beskrive et dokument som er utarbeidet av produsent med det formål å forklare teknisk personell hvordan et gitt produkt skal installeres, vedlkikeholder og/eller repareres. En teknisk manual kan publiseres på en rekke formater tilpasset leserens situasjon og behov.

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.

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.


Eksterne lenker

Alle eksterne linker åpner i et nytt vindu. Jeg tar ikke ansvar for informasjon på eksterne nettsteder, selv om jeg har linket til dem. Vennligst rapporter linker som ikke virker.

Informasjonen på denne siden representerer mine personlige meninger, og min egen forståelse av temaet som beskrives. Du kan gjerne linke til siden, men ikke kopiere større deler av innholdet uten tillatelse. Jeg tar ingen ansvar for eventuelle feil, misforståelser eller manglende informasjon om omfattende temaer. Jeg tar heller intet ansvar for feil du måtte gjøre eller forårsake som et resultat av feilaktig eller manglende informasjon. Du kan gjerne bidra med kommentarer, egner erfaringer eller utfyllende informasjon. Se Kontaktinformasjonen.