Skriftlig Info ➜ Metodikk ➜ Modulære skriving ➜ Hvorfor bruke informasjonselementer
Modulær skriving
---
Spar tid og penger med gjenbruk
Innhold i et informasjonselement
Spørsmålet er selvfølgelig om det er bryet verdt for deg. Det kan ikke jeg gi noe fasitsvar på. I prinsippet er det avhengig av størrelsen og kompleksiteten på de publikasjonene du skriver, hvorvidt de skal oversettes, og om gjenbruk i det hele tatt er ønskelig.
Det er mange fordeler ved å skrive modulært og/eller emnebasert, men det er ingen vits i hvis du ikke har et verktøy som til fulle støtter de funksjonene du trenger. Hvis dette er på plass er det flere grunner til at modulær skriving “lønner seg”.
En av de viktige grunnene til at modulær og emnebasert skriving griper om seg er at informasjonselementene du skriver kan brukes om igjen. Riktig utformet kan både forklaringer og prosedyrer brukes i andre kontekster, i andre bøker, og til og med for andre produkter. Hvor lette det er å gjenbruke informasjon er avhengig av hvordan elementene skrives, men også hvor store of omfattende de er. Små elementer med lite tekst er enklere å gjenbruke, men til gjengjeld kan det bli svært mange av dem. Da vil også forvaltningen av elementene gi deg en utfordring, spesielt hvis du jobber i en arbeidsgruppe.
Store leverandører av dokumentasjonssystem har derfor utviklet avanserte databaser for å øke graden av gjenbruk, og for å holde kontroll på revisjonene på hver enkelt informasjonselement.
I en operatørmanual eller on-line hjelp om et programvareprodukt skal du normalt forklare en del dialogbokser. Da er det lurt å organisere informasjonen om hver dialogboks i et gitt antall informasjonselementer. Disse kan gjenbrukes andre steder i boken, og/eller i andre bøker. For å få til dette må de samme typene informasjonselementene brukes for hver eneste dialogboks. En gunstig effekt av dette er at hver eneste dialogboks blir forklart på samme måte. Det igjen er til hjelp når nye dialogbokser skal beskrives; alle de nødvendige informasjonselementene må “fylles ut”, og deretter plasseres i riktig rekkefølge.
Når du beskriver en dialogboks i en brukermanual vil du sikkert ta med et avsnitt som forklarer hva dialogboksen skal brukes til. Det er naturlig at du bruker litt tid på å få denne forklaringen korrekt og enkel å forstå. Dette avsnittet etablerer du som et selvstendig informasjonselement. Senere vil du skrive en eller flere prosedyrer som forklarer hvordan den samme dialogboksen brukes. Da kan du i disse prosedyrene gjenbruke informasjonselementet som forklarer dialogboksens formål.
Et annet sted i manualen har du en oversikt over menyene. I en kort forklaring til hver meny er det naturlig å ta med en liste over valgmulighetene, og i denne listen kan du nok en gang gjenbruke det samme elementet som forklarer dialogens formål.
På denne måten har du brukt det samme informasjonselement minst tre ganger. Hvis du nå har behov for å endre avsnittet som forklarer hva dialogboksen brukes til vil denne endringen automatisk implementeres all disse stedene.
Slik gjenbruk gjør at sparer tid og penger. Hver gang du klarer å gjenbruke et informasjonselement slipper du å skrive den om igjen. Forutsatt at du vet at elementet finnes, hvor det er plassert i en filstruktur eller en database, og hva det inneholder, kan du hente det inn i så mange ganger du vil.
Tekniske spesifikasjoner har en naturlig plass i mange håndbøker, og denne typen informasjon brukes også ofte i brosjyrer, kataloger og på web. Ofte er det nødvendig og/eller ønskelig at de samme tekniske spesifikasjonene skal inngå flere steder i en bok, eller at de skal gjentas i flere bøker.
Ved å kopiere tekniske spesifikasjoner gjør du det svært vanskelig for deg selv å vedlikeholde denne informasjonen. Tar du derimot og etablerer spesifikasjonene som et eller flere separate informasjonselementer kan de uten problemer gjenbrukes så mange ganger du ønsker det. Ved en endring gjør du dette ett sted.
Det er alltid dyrt og omstendelig å oversette brukermanualer til andre språk. Ved bruk av modulær skriving blir oversetterjobben enklere fordi informasjonselement brukes om igjen. Når et element så er oversatt kan den gjenbrukes, og hver gang du gjør det får du samtidig med deg en "gratis" oversettelse.
Det er her viktig å bemerke at moderne spesialverktøy for oversettelser automatisk vil hente frem et allerede oversatt tekst fra sin database (såkalt "translation memory").
Et kjent ordtak sier at "en god ting kan ikke sies for ofte". Dette er også riktig, men gjelder ikke uten videre for brukermanualer. I slike publikasjoner vil jeg heller vri på dette ordtaket, og si at "en god ting skal sies bare en gang, men da skal den til gjengjeld sies svært godt". Slik er det nemlig med modulær skriving; du skal fortelle det du ønsker bare en gang. Den ene gangen du forklarer skal du legge til gjengjeld legge all din flid i å gjøre det skikkelig bra. Hvis du etter dette trenger denne informasjonen andre steder i brukermanualen (eller i andre manualer) kan du gjenbruke det samme informasjonselementet.
For å kunne gjenbruke informasjonselementer er det ikke nok å skrive dem slik at de kan brukes om igjen. De må også "passe inn" i den nye konteksten de skal brukes i. Dette kan kreve en viss justering av tekstene som brukes før og etter hvert gjenbrukte element. Ofte vil det også kreve en mer konsistent struktur i bøkene dine. Det kan for eksempel være nødvendig å gi kapitler og seksjoner identiske titler i alle bøkene dine, eller sørge for at informasjon blir presentert i samme rekkefølge over alt.
Dette er ingen ulempe for leseren. I mange tilfelle er det slik at en sluttbruker må bruke flere brukerhåndbøker fra samme leverandør, eller kanskje bytter ut en eldre modell med en ny. En konsistent struktur med identiske titler på kapitler og seksjoner i håndbøkene gjør det langt enklere å finne frem fram i dem.
Det er ikke bare stemme og struktur som skaper forskjeller mellom aktørene i en arbeidsgruppe. Varierende språkkunnskaper og ordforråd hos to eller flere forfattere vil også kunne skape forskjeller i teksten. Dette gjelder alle multimodale elementer. Selv enkle strektegninger kan romme store forskjeller i stil og uttrykksform hvis de blir tegnet av ulike illustratører.
Hvis du jobber i en arbeidsgruppe kan en øvelse relatert til informasjonsstruktur være svært nyttig.
Alle som skriver vil bestandig gjøre dette med sin egen "stemme", og uten definerte standarder for hvordan en gitt teknisk manual skal bygges opp vil også strukturen være preget av små eller store personlige preferanser. Det er nok med to forskjellige forfattere i en og samme bok; en erfaren leser vil kunne se hvilke deler av boken som er organisert og skrevet av hver enkelt forfatter. Hvis to forskjellige personer i firmaet skal skrive hver sin installasjonsmanual for hvert sitt produkt, hvor like eller forskjellige blir disse to bøkene? Hva vil en kunde tro om bedriften hvis to produkter blir levert med hver sin installasjonsmanual, og disse ikke er identisk organisert, og kanskje er skrevet på forskjellige måter?
Ved å skrive modulært og/eller emnebasert blir man også i en arbeidsgruppe tvunget til å etablere en rekke regler for fremstilling og bruk av informasjonselementer. Hvilke elementer skal deles? Hvordan skal de bygges opp? Hva skal de inneholde? Hvordan skal de brukes?
Et informasjonselement kan selvfølgelig inneholde et grafisk element, det gjør at tilsvarende regler for slike må diskuteres. Hvor tykke streker skal brukes? Hvilke farger skal brukes? Skal det være tekst og/eller piler på illustrasjonene? Hvilke fonter skal brukes?
Alle disse spørsmålene – og mange flere – må nødvendigvis besvares for at en arbeidsgruppe effektivt skal kunne jobbe med modulær og emnebasert skriving. Selvfølgelig kan en autoritær sjef diktere alle nødvendige regler. Det er langt mer hensiktsmessig at disse reglene lages i fellesskap. Ikke bare tenker flere hoder bedre enn ett, men i fellesskapet får alle et eierskap til de løsningene som velges. Når formålet er at alle skal dra nytte av hverandres innsats ved gjenbruk av felles informasjonselementer dempes den tradisjonelle tankegangen om "min bok" og "din bok". Arbeidsgruppens suksess blir i større grad avhengig av at alle drar lasset sammen og skaper hensiktsmessige informasjonselementer. Enkeltpersoners svakheter og styrker når det gjelder språkferdighet, ordforråd og formuleringsevne vil også kunne jevnes ut når felles elementer kan redigeres og forbedres av alle medlemmene i arbeidsgruppen.
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.