DITA – mis ja milleks

Kui eestikeelsetelt veebilehtedelt otsida sõna DITA, siis on tulemuseks ainult ühe teatud burleskikaunitari nimi. Samas on USAs selle kohta ilmunud mitmeid raamatuid, sadadest veebilehtedest ja konsultantidest rääkimata, ning seda peeti paari aasta eest tehnosuhtluse tulevikuks. Seega – millega siis tegu on?

Mis?

DITA on akronüüm terminile Darwin Information Typing Architecture, tõlkes siis Darwini informatsioonitüüpimisarhitektuur. Kuna see nimi on niivõrd pikk ja lohisev nii inglise kui eesti keeles, siis kavatsen ma muust maailmast eeskuju võtta ja ainult akronüümi kasutada.

DITA on XML keelel põhinev andmemudel . See on avatud standard, mida haldab globaalne organisatsioon nimega OASIS. Üks suurematest DITA toetajatest on ka IBM. Kui Euroopas on DITA vähe levinud, siis USAs on see laialt kasutusel.

Nimi on kokku pandud kolmest komponendist:

  • DITA kasutab spetsialiseerumist ja pärimist, mis on oma olemuselt sarnased Charles Darwini evolutsiooniteooria põhimõtetele.
  • Informatsiooni tüüpimine.
  • Arhitektuur – DITA on laiendatav andmestruktuuride kogumik.

DITA on kõigest raamistik, mitte konkreetne programm. DITAga töötamiseks on mitmeid vahendeid, kuid DITA ise on ainult XML standard.

DITA omadused

Teemadele orienteeritus (topic orientation)

DITA sisu koosneb teemadest, mitte dokumentidest. Iga teema kirjeldab ühte infokogumit, näiteks ülevaade mingist mõistest või sammud mingi toimingu tegemiseks. Enamasti on iga teema eraldi fail.

Kaardid (maps)

DITA kaardid on teemade kogumikud. Iga kaart defineerib teemade struktuuri ja järjekorra. Kaardid võivad viidata ka teistele kaartidele; näiteks võib raamatu jaoks olla üks DITA kaart, mis koosneb viidetest iga peatüki kaardile.

Sisu taaskasutus (content reuse)

Teemasid saab kasutada erinevates dokumentides ja kontekstides. Näiteks võib üks teema sisaldada standardhoiatusi ja -infot, mida siis kasutatakse kõigi erinevate toodete dokumentatsioonis. Samuti saab kasutada ka teemade fragmente.

Metaandmed (metadata)

Nii DITA teemad kui kaardid võivad sisaldada erinevaid metaandmeid (indeksi terminid, autor, toote versioon, ja nii edasi). Neid metaandmeid saab kasutada ka tingimuslikul töötlemisel; näiteks lisada manuaali ainult teemad, mis käivad konkreetse tooteversiooni kohta.

Informatsiooni tüüpimine (information typing)

DITA sisu on reeglina jagatud kolme liiki teemadesse – mõisted, ülesanded ja viited.

  • Mõiste (concept) kirjeldab ühte mõistet – definitsioonid, reeglid, üldinfo.
  • Ülesanne (task) on protseduur, kuidas mingit ülesannet sooritada. See sisaldab alati nimekirja sammudest, mida kasutaja peab tegema. Üldised ülevaated protsessidest (kuidas miski töötab) on mõisted, mitte ülesanded.
  • Viide (reference) on info, mida kasutaja vaatab vastavalt vajadusele, aga ei pea meelde jätma. Viiteteemad on näiteks programmeerimiskäsud, seaded, menüüde või akende kirjeldusedm ja nii edasi.

Spetsialiseerimine (specialization)

Spetsialiseerimine võimaldab lisada uusi elemente, atribuute, või terveid teematüüpe. Seda kasutatakse siis, kui DITA standardist ei piisa. Osadel tööstusharudel on oma standardiseeritud spetsialisatsioonid; näiteks tarkvara dokumentatsiooni jaoks on spetsialiseeritud hulgaliselt elemente – koodi elemendid, menüü elemendid, klahvivajutused, jne. Kuna spetsialiseerimine on osa DITA standardist, siis saab ka spetsialiseeritud DITA sisu töödelda standardvahenditega ilma selleks lisatööd tegemata.

Väljundid

DITA sisu on XML kujul, kuid sellest saab toota erinevaid väljundeid. DITA Open Toolkit on OASISe hallatud vabavaraline kirjastussüsteem, mis toetab paljusid erinevaid väljundeid – HTML, PDF, RTF, ODT, HTML Help, … XSL keele abil on võimalikud ka muud väljundid – mida iganes hing ihaldab.

Vahendid

DITA teemad ja kaardid on XML failid, nii et neid saab muuta suvalise tekstitoimetiga. Kõigele muule (pildid, videod, jms.) viidatakse DITA failides. Samas on mitmeid spetsiaalseid programme DITA toimetamiseks ja avaldamiseks, mis toetavad näiteks teemade eelvaadet. DITA toimetid sisaldavad enamasti ka võimalusi kaardi põhjal valmis dokumente väljastada. Mõned levinumad on oXygen, XMetal, Syntext Serna ja easyDITA.

Viimane nimekiri illustreerib ka ühte kurba ütlust DITA kohta:

DITA is free, but not cheap.

Tõlkes: “DITA on tasuta, kuid kallis.” Kuigi DITA on avatud standard ja vabavaralisest DITA Open Toolkitist piisab DITA dokumentide genereerimiseks, siis DITA kasutusele võtt ja sellega töötamine ei ole odav. Samamoodi võiks öelda, et veebiprogrammeerijatele on vaja ainult Notepadi – kood on ju kõigest tekst.

Põhilised kulud DITA puhul on:

  • Sisu DITA tarbeks vormindamine. Olemasolev sisu tuleb muuta DITA standardile vastavateks teemadeks, mis tihti tähendab kõigi teemade ümber kirjutamist ja organiseerimist.
  • Kujundus. DITA Open Toolkit, mis on ka pea kõikidesse toimetitesse integreeritud, suudab kohe erinevaid dokumente toota, kuid need vajavad lisakujundust.
  • Kirjastamisprotsessid ehk siis see, kuidas täpselt DITA sisu sobivatesse väljunditesse toimetada. See on keeruline protsess, mis hõlmab tervet rida erinevaid komponente.
  • Hooldus. Kui DITAs sisu koostamine on lihtne, siis kujunduse ja kirjastamisprotesside muutmine nõuab programmeerimisoskusi. Ja keskmise programmeerija tunnitasu on mõnevõrra kõrgem kui keskmisel tehnosuhtlejal. 🙂
  • Tarkvara. Nagu eelnevalt öeldud, saab teoreetiliselt DITA faile muuta suvalise tekstitoimetiga. Praktikas on aga vaja vähemalt XML toimetit, mis suudaks XML süntaksit jooksvalt valideerida. Samas on tunduvalt mugavam kasutada mõnda spetsiaalset DITA toimetit, milles on lisaks üldisele XMLi toele ka DITA kirjutamist ja kirjastamist mugavdavad vahendid. Näiteks on väga mugav vaadata DITA kaardi põhjal terve dokumendi eelvaadet ning vajadusel sealt kohe iga teemat avada, et selles jooksvalt parandusi teha.
  • Ümberõpe. Kuna DITA keskendub teemadele, nõuab see täiesti teistsugust lähenemist infole. Inimestel, kes on aastaid Microsoft Wordis või mõnes muus formaadis terveid manuaale kirjutanud, võib see olla väga keeruline ja väidetavalt ei pruugi mõned sellega üldse kunagi hakkama saada.

Lisa kommentaar

Sinu e-postiaadressi ei avaldata. Nõutavad väljad on tähistatud *-ga