Info struktureerimine

DITA arhitektuuri keskne osa, millele viitavad ka kaks keskmist tähte, on informatsiooni struktureerimine vastavalt selle tüübile. Samas ei ole see ainult DITA jaoks vajalik – korralikult struktureeritud info aitab lugejal kiiremini vajalikku infot leida ja sellest aru saada. Lisaks DITA mõiste-ülesanne-viide struktuurile on ka muid alternatiive.

DITA

Kordamise mõttes – DITA põhimõtteks on info lahterdamine kolmeks liigiks:

  • Mõisted (concepts) – “Mis on …” küsimused. Taustainfo, protsesside kirjeldused, ülevaated, ja nii edasi.
  • Ülesanded (tasks) – “Kuidas ma …” küsimused. Juhendid, kuidas samm-sammult mingit tegevust sooritada. Lisaks sammudele kirjeldavad ülesanded ka nõudeid ülesande sooritamiseks, mis peavad eelnevalt täidetud olema, ülesande soorutamise tulemusi, ja muud lisainfot.
  • Viited (references) – sarnase sisuga ja struktuuriga asjad, näiteks programmeerimiskeele käsud, kataloogid, ja nimekirjad. Viidete sisu ei ole otseselt vajalik meelde jätta.

Kui info ei sobi nende teemade alla, saab vajadusel defineerida uusi teemade tüüpe.

Information Mapping

DITA välja töötamisel oli üheks aluseks 1960ndatel aastatel välja töötatud metodoloogia nimega Information Mapping. Lisaks informatsiooni tüüpidele defineerib see ka nõuded info esitamisele ja üpetab, kuidas infot analüüsida ja organiseerida. Information Mapping on registreeritud kaubamärk ning selle kasutamine nõuab litsenseerimist, mis on võrdlemisi kulukas. Seetõttu on see ka tänapäeval vähem levinud.

Information Mapping defineerib kuus info tüüpi:

  • Protseduur
  • Protsess
  • Põhimõte
  • Mõiste
  • Fakt
  • Struktuur

Need on võrdlemisi sarnased DITA tüüpidele – protseduurid on DITA ülesanded; protsessid, põhimõtted, mõisted ja faktid on DITA mõisted; struktuurid on DITA viited.

Muud alternatiivid

Kuna info tüüpideks liigitamine on üldine mõiste, siis on selleks hulk erinevaid süsteeme. Näiteks Kurt Ament kasutab oma raamatus Single Sourcing: Building Modular Documentation viit info liiki:

  • Teema
  • Protseduur
  • Definitsioon
  • Joonis
  • Tabel

Kuna see raamat ei käsitle ainult DITAt, on see hea näide, kuidas teisi info tüüpe defineerida. Sisuliselt võib ju jooniseid (sh. pilte ja diagramme) pidada täiesti eri liiki infoks – hoolimata sellest, mida konkreetne joonis illustreerib, on see esitatud hoopis erineval kujul. Samuti võib näiteks videosid eraldi info tüübiks liigitada. Põhjus, miks erinevad info struktureerimise meetodid seda ei tee, on väga lihtne – alles viimasel aastakümnel on dokumentatsioon hakanud arvuti- ja veebipõhiseks muutuma, samas kui eelnevad aastakümned oli dokumentatsioon rangelt trükitud kujul. Paberilt on raske videot vaadata. 🙂

Siin võiks küll vaielda, kas info vorm (joonis, tabel, video) annab põhjust seda eraldi info tüübina tunnistada? Mina vastan selle peale, et sõltub olukorrast – diagrammidega võib kirjeldada kõiki eelpool mainitud info tüüpe, aga näiteks infokaardid võivad asendada nii mõisted kui viiteid korraga.

Kokkuvõte

Info struktureerimisega on nagu standarditega – vali, mis iganes hetke vajadustele kõige paremini sobib. Aga standarditel on põhjus – standardile vastavad tooted sobivad omavahel kokku ning tõstavad kasutajas usaldust. Sama lugu on struktureeritud infoga – kindla struktuuri kasutamine lihtsustab info koostamist ja täiendamist, eriti kui sama dokumendi kallal mitu inimest töötavad, ja võimaldab kasutajal infot kergemini ära tunda. Seega – pole tähtis, kuidas sa oma infot lahterdad, peaasi, et sa seda teed.

Lisa kommentaar

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