Hvordan skrive gode bruksanvisninger

Med teknisk dokumentasjon menes her instrukser, brukermanualer, prosedyrer og annen informasjon relatert til installasjon, bruk og vedlikehold av mer eller mindre teknisk kompliserte produkter. Profesjonell teknisk dokumentasjon blir normalt produsert av tekniske forfattere eller dokumentører.

Disse websidene er et pågående prosjekt. Under hvert tema mangler fremdeles mange tekster. Kun utvalgte tekster er oversatt til engelsk. Vennligst ha tålmodighet.

Innhold og struktur

Under dette temaet finner du artikler som tar for seg hva slags informasjon dine bruksanvisninger kan og bør inneholde.

Skriving

Her handler det om å skrive kort, enkelt og forståelig. Og det er ikke enkelt!

Metodikk

Hvordan skal jeg jobbe for å skrive bruksanvisninger mest kosteffektivt?

Publisering

Det er ingen vits i å skrive gode bøker og bruksanvisninger hvis kunden ikke får tak i dem.

Layout

Uansett hva slags publisering du bruker skal informasjonen presenteres visuelt.

Bilder og illustrasjoner

Grafiske fremstillinger i forma av fotografier, illustrasjoner og annen multimodal tekst spiller en svært viktig rolle i alle slags bruksanvisninger.

DITA-publisering

Mange opplever at de stanger hodet i veggen når tradisjonelle kontorverktøy brukes til å skrive bruksanvisninger. Ikke minst gjelder det når dokumentene blir store og kompliserte. DITA kan være løsningen.

Verktøy

Godt verktøy er halve jobben. Det å kunne jobbe effektivt med skikkelig verktøy er utrolig viktig.

Relevant akademisk teori

Det er dette det egentlig handler om: din og min evne til å formidle informasjon.

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.

Dette nettstedet er utarbeidet for deg som på en eller annen måte jobber med brukermanualer, bruksanvisninger og teknisk dokumentasjon. Hvordan skal man skrive gode bruksanvisninger?