DITA for teknisk dokumentasjon

Klosser symboliserer DITA

Darwin Information Typing Architecture (DITA) er en XML-basert arkitektur for å skrive, håndtere og levere teknisk dokumentasjon. Ved å bryte ned innholdet i mindre emner (topic) så kan innhold gjenbrukes til flere og forskjellige publikasjoner og versjoner. 

Hvordan fungerer DITA?

Med DITA kan du skrive teknisk dokumentasjon i selvstendige moduler eller emner (topics). Disse emnene må være korte nok til å svare på et enkelt spørsmål, men langt nok til å være fornuftige på egenhånd. Disse emnene er byggeklosser som settes sammen til forskjellige dokumenter (maps) som passer dine behov. Maps er en spesifikasjon for hvordan et dokument er satt sammen av emner og hvilken rekkefølge emnene skal ha i dokumentet. Denne tilnærmingen er effektiv da man skriver og oppdaterer innholdet ett sted og gjenbruker emnene i relevante dokumenter. Hvis man oppdaterer innholdet så vil endringene vises i alle dokumenter som bruker emnene.

DITA inkluderer dokumentformatet XML, som gjør at man kan publisere til web, pdf, hjelpesystemer etc.

DITA-topic-map

Denne måten å jobbe på er det vi kaller strukturert skriving. Ettersom formatet som ligger i bunn er XML, betyr det at DITA er produkt- og systemuavhengig. I kontrast er ustrukturert innhold typisk innhold som eksisterer som ikke-relaterte proprietære medietyper, som Word-dokumenter, regneark, presentasjoner, PDF-filer eller e-post.

Hvorfor DITA for teknisk dokumentasjon?

Det er flere grunner til å velge en dokumentasjonsstrategi basert på DITA og XML for teknisk dokumentasjon:

DITA XML organiserer innholdet ditt i emner

DITA har et kjernesett med emnetyper, slik at du kan organisere små smarte informasjonsenheter i riktig emnetype, noe som resulterer i at innholdet egner svært godt for gjenbruk. Tenk på emner som Lego brikker. Du bruker dem på ulike måter for å bygge det du trenger. Til slutt settes de sammen for å skape mer enn de enkelte delene.

XML skiller innhold fra format, gjør det portabelt og allsidig

Innhold og formatering er ikke lenger kombinert, noe som betyr at de kan administreres og oppdateres uavhengig. Hvis for eksempel merkevaren din endres, og du må oppdatere skriftstørrelsen, fargen og stilen i alle dokumentene dine, blir dette en sentral, engangsendring ettersom innholdet er lagret som XML (tekst format).

En kilde, mange output-formater

De fleste skriver i XML og publiserer deretter til PDF, HTML, og/eller ePub. Det er også mulig å publisere til formater du ikke ville forvente, som Open Office, Excel og PowerPoint.

Utvidbart

Selv om DITA angir hvilke typer emner du bør ha, og kodene eller elementene du bør bruke i hvert emne, er det også ment å være utvidbart. Dette kan gjøres via en prosess kjent som spesialisering. Spesialisering gir deg mulighet til å skrive egne regler som tilfredsstiller behovene til innholdet ditt. I utgangspunktet kan standard DITA være utgangspunktet, deretter spesialiserer du elementer og attributter slik at utvalget tilfredsstiller din bedrifts særbehov.

DITA Open Toolkit

DITA Open Toolkit er en «open source» publiseringsmotor for innhold laget med DITA. Dette er et kraftig publiseringsverktøy der det meste av output-formater allerede er på plass og klart til å tas i bruk. Man kan tilpasse formatering etter organisasjonens ønske.

Rikt utvalg av programmer støtter DITA

Etterhvert som DITA har blitt mer og mer populært har også programvare utvalget økt betraktelig. En typisk infrastruktur i et DITA system består gjerne av en XML editor og et Content Management System (CMS/CCMS) der DITA open toolkit ofte er en integrert del.
På editor siden kan man nevne ledende verktøy som oXygen XML Editor, Adobe FrameMaker og XMetaL Author Enterprise..
Eksempel på CCMS systemer kan f.eks. være XDocs CCMS, IXIASOFT DITA CMS og Vasont DITA CMS pluss en rekke andre systemer.

Hva slags innhold passer DITA til?

DITA er spesielt egnet for teknisk dokumentasjon. En brukermanual leses ikke fra start til slutt. Man leser en manual for å finne ut hvordan man utfører noe, eller for å se hvordan et produkt fungerer. Andre tilfeller så ønsker man å finne relevant referanse – og tilleggsinformasjon.

Når man skriver i henhold til DITA så skiller man på 3 informasjonstyper;

  • Task som er konkret på hvordan man løser en oppgave
  • Concept som er mer beskrivende og retningsgivende
  • Reference som er faktainformasjon

Hvis disse 3 informasjonstypene ikke passer din informasjon så kan man lage sine egne informasjonstyper.

Informasjonstypene er ment som en guide for å skrive enhetlig og gjenbrukbart innhold. Dette sikres gjennom “regler” for dokumentet. Skriver man for eksempel en prosedyre så må man minimum ha med et steg. Slike skriveregler er styrt ved at DITA er basert på XML-format hvor man kan validere at dokumentet er skrevet etter regler.

DITA egner seg til følgende:

  • Teknisk dokumentasjon (manualer, online hjelp, brukerhåndbøker, etc.)
  • Trening og læring
  • Markedsføring
  • Bedrifts dokumentasjon, for eksempel styrende dokumentasjon, artikler og rapporter
  • Bøker

Det er egentlig ingen begrensning på type informasjon – De fleste organisasjoner kan dra nytte av DITA.

Videre lesning og ressurser