Skriftlig Info ➜ DITA-publisering ➜ DITA topics ➜ Innhold og struktur i en topic
Jeg definerer et DITA-emne (topic) som følger:
Et DITA emne (engelsk: DITA topic) er en frittstående datamodul som inneholder multimodal tekst. Modulen har en tittel og nok informasjon til å forklare en spesifikk prosedyre eller et konsept. Enhvert emne er skrevet på en slik måte at det er uavhengig av andre emner og kan gjenbrukes i ulike publikasjoner når dette er hensiktsmessig. Innholdet i emnet er presentert i en flat struktur. Struktur og kontekst etableres når emnet settes inn i et emnekart (engelsk: topic map) sammen med andre emner.
DITA-emner (topics) er nært beslektet med metodikken kjent som "emnebasert skriving":
I teknisk dokumentasjon brukes uttrykket emnebasert skriving (engelsk: topic-based authoring) om en metodikk hvor innholdet i en publikasjon struktureres i frittstående emner (engelsk: topics). Emner kan brukes i vilkårlig rekkefølge innen en gitt publikasjon, og gjenbrukes i andre publikasjoner. Teksten i hvert emne skal ikke forutsette at andre emner er kjent for leseren, og den skal ikke forholde seg til andre emner. Kontekst oppnås ved at ulike emner publiseres i en gitt rekkefølge, og gjerne bindes sammen med hyperlinker.
Les det igjen: "Et emne skal inneholde informasjon som gir mening alene." Hva betyr det?
La oss si at du har et spørsmål knyttet til et produkt du har kjøpt. Produktet kom med en trykt bruksanvisning. Håndboken presenterer alle beskrivelser og instruksjoner for produktet. En av sidene inneholder en komplett seksjon. Denne delen er et emne med en tittel, og emnet gir informasjon relatert til tittelen.
Brukerhåndboken er stor, og du har det travelt. For å spare tid river du siden ut av boken.
Når du setter deg ned for å lese informasjonen på siden du rev ut gir det mening for deg. Informasjonen på siden oppfyller forventningene tittelen ga deg og svarer på spørsmålet ditt. Du innser at for å løse det umiddelbare problemet trenger du ikke å lese resten av boken. Emnet inneholdt den spesifikke informasjonen du lette etter.
Du har kjøpt et digitalkamera. Du må finne ut hvordan du setter inn batteriet.
Instruksjonsmanualen inneholder et avsnitt som heter "Sette inn batteriet". Den finnes på side 244.
Du åpner boken på side 144 og leser instruksjonene.
Alt du trenger å vite er der. Det hele er gitt i det enkelte oppgaveemnet.
Du kan lukke boken.
Du har nettopp kjøpt en brukt TV, men det er noe galt med det. Du må finne noen som kan reparere det.
Instruksjonsmanualen inneholder en del kalt "Service og reparasjon". Den finnes på side 25.
Du åpner boken på side 25 og finner en komplett liste over verksteder. Listen er komplett med navn, adresser og relevant kontaktinformasjon.
Alt du trenger å vite er der. Alt er gitt i det enkelte konseptuelle emnet.
Du kan lukke boken.
Partneren din har kjøpt et kostbart kjøkkenverktøy. Den er utstyrt med mye ekstra tilbehør. Et av disse tilbehørene fanger oppmerksomheten din, men du trenger hjelp til å forstå hva den skal brukes til.
Instruksjonsmanualen inneholder en del kalt "Tilleggsutstyr". Den finnes på side 56.
Du åpner boken på side 56 og finner en illustrasjon. Illustrasjonen identifiserer hver del og presenterer en kort beskrivelse av bruken. Det henvises til detaljerte beskrivelser og prosedyrer.
Alt du trenger å vite er der. Alt er gitt i det enkelte konseptuelle emnet.
Du kan lukke boken.
Gressklipperen din har stoppet, og du har tatt den med inn i garasjen for å fikse den. Du innser at du må bytte ut en bestemt del.
Instruksjonsmanualen inneholder et avsnitt kalt "Reservedeler". Den finnes på side 76.
Du åpner boken på side 76 og finner en illustrasjon som identifiserer hoveddelene til gressklipperen. For hver del henvises det til en dedikert reservedelsseksjon. Du kan enkelt finne delen du trenger, og åpner den aktuelle siden. All nødvendig informasjon er der, for eksempel en illustrasjon, delens navn og ordrenummer. Det er til og med en lenke til et nettsted som viser alle forhandlerne som kan selge deg delen.
Alt du trenger å vite er der. Alt er gitt i det enkelte reservedelsemnet.
Du kan lukke boken.
Du har kjøpt et nytt program for hjemme-PC'en din, men en av dialogboksene er vanskelig å forstå. Den tilbyr mange parametere som er langt fra intuitive.
Du velger Hjelp-knappen for å åpne den kontekst sensitive elektroniske hjelpen. Den åpner en side som forklarer all funksjonaliteten som dialogboksen tilbyr, pluss lenker til relaterte prosedyrer.
Alt du trenger å vite er der. Alt er gitt i det enkelte referanseemnet.
Du kan lukke den elektroniske hjelpen.
I de første eksemplene har jeg vist til en tradisjonell trykt bruksanvisning. Informasjonen kan selvfølgelig være tilgjengelig på alle medier, inkludert en interaktiv elektronisk teknisk manual (IETM).
|
Den grunnleggende ideen med emnebasert skriving er at du samler all informasjonen din i emner som alle "gir mening av seg selv". Ved å bruke disse emnene kan du sette sammen en komplett håndbok ved å plassere emnene i hvilken som helst rekkefølge og struktur som passer ditt formål. |
Når du har laget disse emnene kan du også bruke dem gjentatte ganger i mange håndbøker.
|
DITA handler om deling og gjenbruk. Hvis du lager flotte emner kan du bruke funksjonaliteten DITA tilbyr til å gjenbruke dem i mange publikasjoner. Du kan også gjenbruke emnene som er laget av kollegene dine, på samme måte som de kan gjenbruke emnene du lager. Til slutt kan du spare tid og penger. |
Et emne har en flat struktur. Det har en tittel, en kort introduksjon og deretter den nødvendige multimodale teksten. Avhengig av hvordan stilarket ditt er laget er tittelen inkludert i innholdsfortegnelsen når du publiserer boken.
Det er ikke mulig å lage titler innenfor et emne og plassere disse i innholdsfortegnelsen. Du kan ikke gjøre dette fordi du ikke kan lage en "understruktur" i emnet. Du kan fortsatt legge til seksjoner, og hver seksjon kan ha en tittel. Hensikten med slike titler er å dele informasjonen inn i tekstbiter som er lettere å lese.
Akkurat denne siden du leser akkurat nå bruker samme struktur. Denne siden har en tittel og flere separate seksjoner med individuelle titler. Disse seksjonstitlene vises ikke i listen over sider.
Seksjonene og seksjonstitlene er ikke obligatoriske. Du bestemmer hvordan du skal bruke disse i konseptet og referanseemner. Oppgaveemner har en annen struktur, så disse vil normalt inneholde seksjonstitler. Likevel vil du alltid ha ansvaret – med mindre stilarket ditt tilsier noe annet.
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.