Dokumentasjon


Med begrepet dokumentasjon menes vanligvis en skriftlig beskrivelse av hva en gjenstand, funksjon eller tjeneste kan gjøre, og hvordan den brukes. "Riv her" på sukkertøyposen er dokumentasjon; verkstedmanualen til din nye Imperial Blue Ford Focus RS er dokumentasjon, liksom brukerhåndboken til din Toshiba Satellite Pro er dokumentasjon.

Jeg/vi oversetter mangt og mye, men når det gjelder utarbeidelse - forfatterskap, for å si det litt pretensiøst - av dokumentasjon, begrenser jeg meg til ett smalt felt: Utarbeidelse av brukerhåndbøker for Windows-basert programvare innenfor bestemte fagområder.

Hvorfor ekstern dokumentør?

bullet Unngå kostnader til heltids ansatte når dokumentasjon tar mindre enn ett årsverk
bullet Unngå å øke staben med faste stillinger ved periodisk høyt aktivitetsnivå.
bullet Knytt dokumentasjon til prosjekt, og avgrens kostnader og varighet
bullet Resultatet av kompetansen holdes i bedriften, i form av ferdig dokumentasjon

Fremgangsmåte

Dokumentøren går som oftest inn i bedriften, og arbeider sammen med utviklerne for å lære produktet og formidle sine kunnskaper til brukerne. Dette krever generelle Windows-kunnskaper, grei skriftlig fremstillingsevne, viten om verktøyet som brukes, og viten om ulike plattformer som arbeidet skal utgis på. Den viktigste kunnskapen er likevel produktkunnskapen, som befinner seg i din virksomhet, og hos dine kunder. Det er denne som dokumentøren må få tak i, og få ned på papiret, billedlig talt. Papir er snart det eneste mediet visse typer dokumentasjon ikke produseres på.

m_officeMicrosoft Word
Fremragende kjennskap til verktøyet er viktig. Trenger du å få din dokumentasjon utarbeidet med et annet verktøy enn MS-Word, trenger du en annen dokumentør.

WinHelp, HTML-hjelp, eller...

Ja takk, begge deler. Du trenger i hvert fall dokumentørens forståelse og kjennskap til ulike plattformer, og hva som kan gjøres på de enkelte.

robohelpRoboHelp? Doc-to-Help?
Disse er ledende verktøy for utvikling av hjelpesystemer basert på brukerhåndbøker i form av Word-dokumenter. De har sine fordeler og ulemper; fortell meg hva som er viktig for deg, og jeg hjelper deg å velge verktøy for begge. Jeg har selvsagt lisensierte versjoner av begge; ønsker du å videreutvikle det ferdige hjelpesystemet selv, må du anskaffe din egen lisens.

Referanser

siemensSiemens Business Services AS
Nå en avdeling av Siemens; har avhendet avdelingen DocuLive, som produserte systemer for dokument- og saksbehandling i privat og offentlig virksomhet. Håndbøker og hjelpesystemer ble produsert av meg som dels ekstern, dels ansatt dokumentør frem til slutten av 1997.

telenorTelenor Mobil
Etter suksessen med MobilKontor, valgte Telenor Mobil å lage sin egen MobilKontor 2. Utviklingsoppgaven ble gitt til A/S EDB, som ble rådet til å velge den samme dokumentøren som hadde lokalisert MobilKontor 1. Til sammen har Telenor solgt et femsifret antall av de to programpakkene for oss som bare MÅ sjekke eposten fra trikken.