Skriftlig Info ➜ Metodikk ➜ Modulære skriving ➜ Ulemper med modulær skriving

Ulemper med modulær skriving

Modulær skriving

Startside

---

Om modulær skriving

Spar tid og penger med gjenbruk

Informasjonselementer

Innhold i et informasjonselement

Hvorfor bruke informasjonselementer

Ulemper med modulær skriving

Krav til verktøy for modulær skriving

Selv om modulær og emnebasert skriving stadig blir mer vanlig er klart at det finnes noen ulemper med denne metodikken. Det er viktig å være klar over at nye applikasjoner og dokumentasjonssystemer for teknisk dokumentasjon i stadig større grad oppveier flere av disse ulempene.

Først og fremst er modulær og emnebasert skriving metodikk som må læres. Hos mange er den lineære informasjonsstrukturen tillært og erfart i løpet av mange års skolegang, og da oppleves den modulære organiseringen av informasjonselementer som en helt annen måte å tenke og skrive på. Ikke alle synes det er like enkelt.

Det kan bli mange filer

Det kan bli mange filer. Ved å praktisere modulær og emnebasert skriving vil hver eneste bok du skriver egentlig bestå av en mengde separate filer. Dette krever at du må ha et system for å finne frem til de informasjonselementene du har laget, slik at de kan brukes om igjen. Jobber du alene er ikke dette noen umulig oppgave, men straks det er flere forfattere som deler på skriveoppgavene blir det vanskeligere.

Hvordan kan jeg vite hvilke informasjonselementer de andre har skrevet, hvor de ligger, og hvordan de skal brukes?

Løsningen er ofte et avansert databasesystem som kan holde rede på elementene, og som i tillegg kan gi deg informasjon om hvor de er brukt og hvilke revisjoner som forekommer. Ved hjelp metainformasjon i filene og en søkemotor kan du da - til en viss grad - finne frem til informasjonselementer som du kan bruke.

Jeg sier "til en viss grad", for selv med en avansert database kreves en intern organisering og struktur som ikke nødvendigvis ligger ferdig i pakkeløsningen fra leverandøren.

Du må bruke et egnet verktøy

Modulær og emnebasert skriving krever at du har et verktøy som støtter de spesielle funksjonene som kreves. Hvis du i dag bruker et tradisjonelt tekstbehandlingsverktøy kan det godt tenkes at du må bytte. Dette er i så fall en prosess som krever omtanke og planlegging.

Det finnes en rekke avanserte verktøy på markedet, noen av dem er til og med gratis. Jobber du profesjonelt med å skrive teknisk dokumentasjon vil du likevel trenge et profesjonelt verktøy. Det koster penger, både i innkjøp, vedlikehold og opplæring.

Du blir kanskje alene

En fjerde ulempe med modulær skriving er en bivirkning av det verktøyet du bruker. Siden normale kontorstøtteverktøy tradisjonelt ikke støtter de funksjonene du trenger vil du kanskje bli plassert på en "øde øy" med ditt "sære" verktøy og "spesielle" behov. Mange vil bruke dette som et argument mot deg.

Hvordan skal andre medarbeidere på avdelingen kunne bidra med tekst til deg? Hvordan skal de kunne lese korrektur, og eventuelt endre, på de tekstene du har laget?

Du må bli vant til å gjenta deg selv

Tidligere har det vært en uskrevet regel for de fleste av oss at vi ikke skal gjenta oss selv. Man skal beskrive noe bare en gang, og deretter henvise til det.

Den regelen gjelder fremdeles, men med modulær og emnebasert skriving kan vi tillate oss å bli litt nyanserte.

Hvis du skriver en stor og tykk bok som også skal ut på papir kan det være hensiktsmessig å gjenta viktig informasjon, merknader og andre faktaopplysninger flere steder. Det er enkelt å få til når den samme informasjonselementet kan hentes inn flere steder, og det kan spare leseren for masse blaing. Dette er spesielt hensiktsmessig ved emnebasert skriving.

Eksempel

I en av mine publikasjoner er det nødvendig å sette viktig informasjon inn i en merknad. Det er en relativt stor bok, og vi kan ikke forutsette at den blir lest lineært. Da kan vi ikke plassere denne viktighe merknaden inn foran i boken, og deretter tro at den blir lest. Den må settes inn alle stedene der den gjelder. Siden dette er flere steder i boken har jeg etablert et merknaden som et informasjonselement som gjenbrukes mange steder. Skulle produktsjefen senere ønske å gjøre en endrig, vel, da retter jeg ett sted.

Hvis et emne deles opp i flere uavhengige elementer og du forventer at disse elementene leses hver for seg kan det også være en fordel å etablere en slags felles innledning som kan brukes i begynnelsen av hvert element for å sette leseren inn i riktig kontekst. Dette er lett å få til ved å etablere denne innledningen som et eget informasjonselement, og deretter gjenbruke det flere steder.


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.