Ce este dita și de ce avem nevoie de ea, elaborarea documentației tehnice

Ce este DITA și de ce avem nevoie de ea?

"Cheia înțelegerii principiului DITA este de a înțelege modul în care folosește subiecte, hărți și formate de ieșire. Voi explica toate acestea în detaliu, dar aici e imaginea generală: creați conținut vDITA-subiect, carte ispolzueteDITA, pentru a determina ce subiecte vor cădea în fiecare din furnizarea, apoi procesează aceste carduri cu definiția de ieșire formataDITAdlya crea rezultatul final ".







Mulți dintre dezvoltatorii de astăzi ai programelor metodice se confruntă cu o mare dilemă.

Elevii au foarte puțin timp să înțeleagă și să învețe cum să utilizeze eficient produsele și sistemele complexe. Pentru a rula programele de formare rațională, dezvoltatorii trebuie să le ofere studenților conținut de învățare de înaltă calitate, care să fie personalizat pentru rolurile specifice ale elevului și cu capacitatea de a le livra la timp utilizatorului. În același timp, bugetul pentru dezvoltarea multor programe de formare este în scădere. Pe scurt, studenții au puțin timp și bani să învețe ce trebuie să știe și dezvoltatorii au puțin timp și bani pentru a oferi studenților ceea ce au nevoie.

O modalitate prin care dezvoltatorii pot rezolva această dilemă este reutilizarea mai eficientă a conținutului. Pentru mulți dezvoltatori, cea mai bună modalitate de a atinge această eficiență este Specificația privind conținutul de predare (LTC), care este lansată în versiunea 1.2 a arhitecturii darwiniste a informațiilor tipărite (DITA).

"Eliberarea a ceea ce?" - Desigur, unii cititori vor întreba. Înainte de a răspunde, permiteți-mi să vă dau o idee despre "de ce". În cadrul proiectului de testare DITA pentru caietul de sarcini LTC, echipa IBM a învățat cum să reutilizeze conținutul cursului de formare existent. Au constatat că 50% din conținutul cursului a fost copiat din documentația produsului. Folosind această specificație, ei sunt capabili de a automatiza o mare parte a unei astfel de reutilizare nu este numai evitarea costurilor și capacitatea de a copia manual și lipiți eroarea, dar, de asemenea, oferă o modalitate eficientă de a sincroniza actualizările de conținut între documentare și materiale de instruire și de economisire pe costurile de traducere, fără a lua un singur conținut de două ori. Nu merită să afli mai multe despre asta?

In acest articol voi da o descriere și istorie scurtă a DITA, explică modul în care DITA promovează reutilizarea diferite tipuri eficiente și universale de livrare de conținut final și va discuta despre modul în care caietul de sarcini LTC DITA se concentrează pe beneficiile de formare.

De ce e Darwin?
Mulți oameni care nu cunosc DITA, întreabă: "Și unde este Darwin în arhitectura darwiniană a informațiilor tipărite?". În cadrul teoriei sale de selecție naturală, naturalistul Charles Darwin a remarcat că plantele și animalele moștenesc trăsăturile părinților lor. În mod similar, multe elemente din DITA moștenesc atributele elementelor părinte. Arta reflectă natura.

DITA este utilizat pe scară largă în lumea documentației tehnice în companii precum Cisco, IBM (desigur), Nokia și Oracle. Dar introducerea DITA este tipică nu numai pentru tehnologiile înalte. Boeing și Administrația Veterinară pentru Sănătate din Statele Unite s-au alăturat deja comitetelor DITA, iar eu personal am ajutat la transferul documentației pentru ITT Fluid Technologies (producătorul pompelor și supapelor) către DITA. Punerea în aplicare a DITA a rămas în spatele lumii formării profesionale, ceea ce nu este surprinzător, având în vedere importanța inițială a DITA asupra publicațiilor tehnice și nu a conținutului didactic.

Cheia înțelegerii principiului DITA este înțelegerea modului în care folosește subiecte, hărți și formate de ieșire. Voi explica în detaliu, dar aici e imaginea generală: creați conținut în subiecte DITA, utilizați DITA-hartă pentru a determina ce subiecte vor cădea în fiecare din furnizarea, apoi procesează aceste carduri cu definiția de formatul de ieșire DITA pentru a crea rezultatul final.

Subiectele DITA au o anumită structură. Acest lucru se face pentru coerența dintre subiecte, în special subiectele dezvoltate de diferiți oameni. De exemplu, o sarcină-subiect poate include în ordinea specificată:

  • antet;
  • prerequisite (ceea ce trebuie să știți, să aveți sau să-l faceți elevului înainte de a finaliza sarcina);
  • acțiuni de acțiune;
  • rezultatul așteptat al sarcinii;
  • post-rechiziții (ceea ce studentul trebuie să facă după terminarea sarcinii).

Puteți schimba această structură după cum doriți. De exemplu, puteți solicita ca fiecare sarcină să aibă un titlu, informații suplimentare, acțiuni și rezultate așteptate, dar să lase includerea de pre-cerințe și post-rechiziții pentru dezvoltatorii fiecărui subiect.

DITA oferă în mod implicit trei tipuri de subiecte, fiecare având structura proprie și regulile implicite. Puteți utiliza acest subiect concept pentru revizuire și informații contextuale asociate cu acest subiect, sarcina de a obține informații cu privire la sarcini specifice și subiect-notă de subsol pentru mai multe informații, cum ar fi specificațiile de sistem, numere de o parte, și sintaxa documentului. DITA 1.0, 1.1 oferă de asemenea un subiect universal, pe care dezvoltatorii DITA îl pot adapta nevoilor lor. DITA 1.2 introduce în mod implicit tipuri suplimentare de subiecte, dintre care unele fac parte din specificația LTC. Le voi descrie mai târziu în secțiunea "Care este specificația DITA LTC".

Prin acest punct, s-ar fi putut gândi, "Oh, toate chestiile astea despre DITA sunt destul de complicate". Adevărul este că există câteva aspecte foarte complexe ale DITA, dar mecanica de bază a subiectelor în dezvoltare în DITA este relativ simplă. Figura 1 prezintă codul DITA pentru un subiect topic simplu.

Ce este dita și de ce avem nevoie de ea, elaborarea documentației tehnice

Ce este dita și de ce avem nevoie de ea, elaborarea documentației tehnice






Vă voi atrage atenția asupra unor caracteristici ale acestor desene.

În al doilea rând, la fel cum exemplele de mai sus conțin o imagine, puteți include în subiectul DITA aproape orice conținut multimedia: audio, film flash etc. Ca și în HTML, aici puteți include hyperlink-uri la conținutul de pe Internet. Principalul lucru despre care ar trebui să vă amintiți este formatul versiunii finale (din propria mea experiență spun că animația GIF nu se mișcă foarte bine în formă tipărită).

Pentru a asigura livrarea țintă pentru un anumit produs, public sau scop, se utilizează cardurile DITA. Dita-map este o listă de indicii pentru un set de subiecte specifice, care determină ce subiecte ar trebui să fie incluse în livrare. De asemenea, harta definește ordinea și ierarhia subiectelor și oferă navigare, cum ar fi cuprinsul și referințele încrucișate între subiectele din versiunea finală.

Hărțile pot fi create în orice etapă de lucru cu DITA. Unii dezvoltatori folosesc hărțile ca instrument de planificare și urmărire înainte de a crea subiecte, în timp ce alții creează hărți după elaborarea subiectelor. În orice caz, ambele hărți finale și subiectele sunt necesare pentru a crea livrarea finală.

Ce este dita și de ce avem nevoie de ea, elaborarea documentației tehnice

Într-un mediu real, subiectele DITA legate de multe hărți vor fi mult mai mari decât cele indicate în exemplu. De regulă, mai mult de jumătate din subiecte sunt utilizate de diferite hărți.

Reamintim că specificația DITA 1.2 definește tema DITA ca "un bloc denumit de informații care poate fi înțeles separat de alte blocuri și folosit în contexte diferite". Hărțile contribuie la înțelegerea motivului pentru care este atât de important ca conținutul să aibă un context neutru în toate subiectele posibile, acolo unde este posibil. De exemplu, dacă ați folosit o grămadă: "Anterior ați studiat ..." sau "În subiectul ABC ...", atunci au stabilit o relație între cele două subiecte. Dar, în cazul în care într-una din livrări lipsește alt subiect sau într-o altă ordine, veți îndruma oamenii spre conținut incorect sau inexistent. Dacă totuși trebuie să utilizați legături text între subiecte, există modalități de a face acest lucru, dar acest lucru nu se aplică acestui articol.

Deși Figura 3 arată, nu este deloc necesar să includeți un subiect în hartă. Subiectele și hărțile DITA pot utiliza în mod activ metadatele pentru a procesa date în funcție de condițiile specificate (filtrarea), oferind posibilitatea de a utiliza diferite opțiuni pentru subiect atunci când procesează harta. Să presupunem că avem trei subiecte "Despre (ceva)", conținând conținut absolut identic, cu excepția frazei introductive. Putem crea un singur subiect "Despre (ceva)" și să includem trei variante diferite de fraze introductive, apoi să aplicăm metadate pentru a indica care dintre fraze corespund fiecărui produs. Referința la metadatele din hartă determină care dintre fraze ar trebui incluse în text în fiecare caz.

Hărțile pot indica nu numai subiectele, ci și alte hărți. Această posibilitate poate fi folosită, de exemplu, pentru a crea o hartă a fiecărei lecții în curs; Apoi folosiți o altă hartă pentru a indica ce lecții ar trebui incluse în curs și în ce ordine. Ca și în cazul subiectelor, dacă se schimbă ceva în hartă, modificările sunt afișate în toate hărțile care se referă la aceasta.

Trebuie să recunoaștem că Figura 3 prezintă un exemplu foarte simplu; Am auzit că IBM susține în prezent peste un milion de subiecte DITA și cine știe câte cărți. Dar chiar și acest exemplu ilustrează bogăția posibilităților și versatilitatea DITA. Iar formatele de ieșire, care vor fi discutate mai târziu, vor extinde și mai mult aceste oportunități.

Deoarece DITA utilizează etichetarea semantică, nu etichetele de formatare, este formatele de ieșire care controlează aspectul livrării. Mulți dezvoltatori DITA modifică formatele de ieșire furnizate astfel încât să se potrivească cu șabloanele dezvoltate mai devreme în Microsoft Word sau Adobe FrameMaker. Modificarea formatului PDF este deosebit de atrăgătoare, dar există multe instrumente care ajută la simplificarea acestei lucrări.

Și cum rămâne cu sistemele de gestionare a conținutului?
Adesea se pune problema utilizării sistemelor de management al conținutului (CMS) împreună cu DITA. CMS oferă o varietate de funcții utile, cum ar fi controlul sursei și prezentarea generală a managementului temei Dita, a hărților și a formatelor de ieșire. Deși multe instrumente DITA pot coopera în mod profitabil cu CMS, disponibilitatea acestora nu este necesară. CMS poate fi costisitor de implementat, analizând cu atenție nevoile dvs. specifice.

Apreciaza versatilitatea incredibila a fiecarui subiect DITA. Hărțile pot include subiecte, definesc ordinea și ierarhia subiectelor, includ doar conținutul relevant pentru un produs, obiectiv sau public și, în cele din urmă, creează o livrare care conține acest subiect în diferite formate de ieșire. Dacă ceva se schimbă în subiect, atunci aceasta va afecta versiunea finală.

La începutul articolului am menționat DITA Specificația privind conținutul de învățare (LTC) și cum îl aplică IBM pentru a automatiza reutilizarea conținutului, sincronizarea acestuia cu documentația produsului și economiile în traducere.

Specificația este o funcție care oferă o flexibilitate și mai mare dezvoltatorilor DITA. Cele trei tipuri de teme de bază disponibile în DITA (concepte, sarcini și note de subsol) funcționează bine cu publicațiile tehnice, dar nu sunt întotdeauna convenabile pentru a furniza conținuturi de învățare. Pentru astfel de livrări, este posibil să aveți nevoie de tipuri speciale de subiecte pentru a evalua materialele de antrenament și sumar, precum și etichetele speciale create pentru conținutul de instruire.

Comisia a elaborat Specificația privind cele mai bune evoluții metodologice utilizate în industria de formare, însă specificația nu se axează pe niciun model de formare special.

LTC Specificația oferă o mare varietate pentru dezvoltatorii de conținut educațional. Acesta include tipurile de teme create special pentru planurile de antrenament, anchete, materiale informative, rezumate, evaluări; precum și numeroase etichete speciale concepute, de exemplu, pentru notele de instructor, elementele de evaluare (întrebări închise și deschise, întrebări cu alegerea unei singure opțiuni etc.). De asemenea, specificația sprijină metadatele specifice învățării (de exemplu, timpul de învățare și nivelul de dificultate).

Datorită naturii moștenite a DITA, chiar dacă dvs. sau alți dezvoltatori creați subiecte DITA în afara specificațiilor LTC, puteți utiliza în continuare subiectele LTC și LTC împreună. De exemplu, puteți crea o hartă a lecțiilor care începe cu o prezentare generală a LTC, apoi se referă la câteva subiecte non-LTC din documentația produsului și apoi se termină CV-ul și evaluarea de la LTS. În DITA, conceptele de bază pe care le-am descris în acest articol sunt aplicabile specificațiilor LTC; De exemplu, puteți crea lecții sau cursuri întregi utilizând un card DITA și, de asemenea, să generați livrări finale utilizând formate de ieșire.

Deci, de ce avem nevoie de DITA și LTC Specification? Să presupunem că lucrați cu cantități mari de conținut de formare, copiați conținutul din diferite surse sau lucrați cu echipe mari, care au nevoie de o mai bună coerență a conținutului. În acest caz, DITA și specificația LTC pot fi o soluție excelentă pentru dvs. încât studenții să aibă puțin timp și bani să studieze și trebuie să le oferiți tot ce aveți nevoie. În cazul în care aspectul Specificații LTC va duce la faptul că DITA 1.2 învățare răspândit în rândul dezvoltatorilor cât mai repede DITA 1.0 și 1.1 răspândirea în documentația tehnică din lume, este probabil ca seful tau va fi în curând interesează, mai degrabă decât să introduceți Are organizația dvs. DITA.

De la apariția DITA, multe organizații care utilizează DITA pentru documentația tehnică și-au dat seama cât de profitabile sunt în ceea ce privește economia de timp și bani și, în același timp, îmbunătățirea calității și versatilității. De asemenea, au descoperit alte beneficii ale colaborării cu DITA, cum ar fi mai multe oportunități de colaborare în mediul de dezvoltare.

Odată cu introducerea specificației LTC, toate aceste beneficii au devenit disponibile dezvoltatorilor de instruire. În plus, specificația oferă oportunități de cooperare între echipele implicate în instruire și documentare. Înțeleg că, de obicei, astfel de echipe lucrează separat, iar una din aceste tehnologii nu va satisface toate abordările pentru a lucra cu conținut, dar totuși posibilitățile de a utiliza DITA în afaceri sunt foarte atractive. Este ușor de implementat DITA? Nu, nu este. Va plăti cu timpul? Dacă totul este planificat și implementat în mod corespunzător, este posibil.

Referințe și surse

De asemenea, ar putea fi interesat de:







Trimiteți-le prietenilor: