exemplu

Acest exemplu este conceput pentru a pregăti creatorii de conținut să sară în lumea DITA.

Darwin Information Typing Architecture (DITA) este un standard deschis pentru XML care este utilizat pentru a crea, structura și distribui conținut. În esență, este o metodologie pentru scrierea elementelor de bază de conținut care pot fi organizate și reutilizate cu ușurință pe platforme.

Aflați elementele de bază ale arhitecturii de tipare a informațiilor Darwin (DITA).

În DITA, conținutul este împărțit în subiecte independente, apoi aranjat în hărți de conținut și publicat pe mai multe ieșiri media.

Arhitectura de tipare a informațiilor Darwin (DITA) este un standard deschis pentru limbajul extensibil de marcare (XML) care este utilizat pentru a crea, structura și distribui conținut. DITA a fost dezvoltat la IBM. Dar adoptarea sa pe scară largă poate fi atribuită faptului că DITA a devenit un standard deschis. În esență, este o metodologie pentru scrierea elementelor de bază de conținut care pot fi organizate și reutilizate cu ușurință pe platforme.

Ce înseamnă „DITA”?

„DITA” înseamnă Darwin Information Typing Architecture.

„Darwin” se referă la Charles Darwin, care a dezvoltat conceptul științific de moștenire a trăsăturilor. În DITA, aceasta se referă în primul rând la relațiile părinte-copil cu subiectele. Un copil moștenește trăsături sau atribute de la părintele său.

Tastarea informațiilor nu se referă la tastarea informațiilor de fapt pe o tastatură, ci mai degrabă la clasificarea informațiilor. DITA folosește o abordare structurată a autorului, incluzând tipuri și elemente de subiect definite. De exemplu, un subiect conceptual transmite informații conceptuale, iar un subiect de activitate conține informații procedurale.

IBM definește DITA în felul următor:

Darwin Information Typing Architecture (DITA) este o arhitectură bazată pe XML, de la capăt la cap, pentru autor, producere și livrare de informații tehnice. Această arhitectură constă dintr-un set de principii de proiectare pentru crearea modulelor „tipizate de informații” la nivel de subiect și pentru utilizarea conținutului respectiv în moduri de livrare, cum ar fi ajutorul online și portalurile de asistență pentru produse de pe Web.

Pentru mai multe informații, consultați DITA.

Istoria DITA

DITA a fost creat de IBM, în 2001, pentru a înlocui formatul lor dificil și dificil IBMDoc. Odată ce IBM a realizat avantajele standardizării pentru industria tehnică a scrierii, IBM a acordat DITA Organizației pentru Avansarea Standardelor de Informații Structurate (OASIS). În 2005, OASIS a lansat public DITA.

Cum se utilizează DITA astăzi?

Motivul pentru care DITA s-a răspândit în multe industrii se datorează faptului că este un standard deschis. Imaginați-vă cât de diferit ar fi internetul dacă HTML nu ar fi fost deschis publicului.

Clienții de software și tehnologie folosesc frecvent DITA pentru a-și documenta produsele. Producătorii din multe industrii folosesc DITA, de exemplu producătorii de hardware, semiconductori și dispozitive medicale. DITA este, de asemenea, utilizat de companiile de e-learning, companiile financiare, organizațiile de politici și standarde și multe alte industrii.

Adoptarea standardului DITA a permis acestor industrii să-și facă producția și întreținerea documentelor mult mai eficiente și mai eficiente.

Să vedem un exemplu de funcționare.

Să presupunem că produceți două modele ale unor produse, modelul A și modelul B. În timp ce cele două modele prezintă unele diferențe, modelele A și B împărtășesc mult conținut. Pentru a scrie manuale de utilizare pentru fiecare model folosind DITA, creați subiecte individuale, cum ar fi o introducere, siguranța produsului, instrucțiuni, specificații de produs etc.

Pentru a crea un ghid de utilizare pentru fiecare produs, creați o hartă separată pentru fiecare, modelul A și modelul B, și adăugați subiectele specifice fiecărui model pentru a construi un cuprins pentru fiecare. Ambele modele împărtășesc, adică reutilizează, un anumit conținut din fiecare manual, în timp ce un anumit conținut este specific fiecărui model. Ideea este că scrieți conținutul partajat o singură dată și apoi ambele modele pot utiliza aceleași subiecte. Apoi, când ghidurile dvs. sunt complete, puteți publica pe mai multe ieșiri media prin simpla apăsare a unui buton.

DITA are multe beneficii atât pentru managementul afacerii, cât și pentru procesele tehnice.

Conținutul DITA este împărțit în trei tipuri principale de subiecte:

Tip subiect DescriereExemplu
ConceptOferă informații conceptuale despre ceva. Răspunde la întrebarea „Ce este”.Introducere în prăjitorul de pâine
SarcinăOferă informații procedurale care vă arată cum să efectuați o sarcină. Răspunde la întrebarea „Cum fac eu?”Curățarea prăjitorului de pâine
ReferințeOferă informații de sprijin, de obicei în tabele, cum ar fi specificațiile.Piese de prăjit

Concepte

Subiectele conceptuale îi ajută pe cititori să își lege cunoștințele existente de un nou produs sau sarcină. Dacă furnizați instrucțiuni pentru „Instalarea OS-XT29”, cititorul dvs. s-ar putea întreba ce este OS-XT29, cum diferă de alte versiuni, ce face și multe altele. Subiectele conceptuale oferă acele informații lipsă.

Acest concept este folosit ca o introducere pentru un manual de prăjitor de pâine:

Introducere Classic Toaster

Classic Toaster ™ este mașina de mic dejun clasică, unică, pe care ți-ai dorit-o de când erai suficient de mare pentru a mânca alimente solide. Aveți felii perfecte de încântare cu gemul sau untul dvs. preferat. Obțineți cu ușurință covrigi prăjiți cu o apăsare de buton.

Sarcini

Subiectele de activitate răspund la întrebarea „Cum fac?”. Acestea oferă informații pas cu pas care îi spun unui utilizator cum să facă ceva. Subiectele de activitate sunt inima conținutului DITA. Acestea oferă informațiile de bază pe care cititorii le caută în documentație. Adică, subiectele de activitate oferă informații utilizatorilor de care au nevoie pentru a-și atinge obiectivul, de exemplu, pentru a configura ceva. Subiectele conceptuale și de referință completează subiectele sarcinii cu informații legate de conținutul subiectului sarcinii care nu aparține subiectului sarcinii în sine.

Structura de bază a sarcinilor este următoarea:

  1. Titlu: Numele sarcinii
  2. Cerință prealabilă: Ce trebuie să știe cititorul înainte de a efectua sarcina
  3. Pași de activitate: instrucțiuni pas cu pas
  4. Rezultat: Rezultatul finalizării sarcinii

Puteți utiliza o parte sau toată această structură pentru a stabili un standard de conținut. A avea un titlu și pași ar putea fi obligatoriu, dar o condiție prealabilă ar putea fi opțională. Există elemente suplimentare care pot fi adăugate la o activitate, cum ar fi rezultatele pașilor sau sub-pașii.

Iată un exemplu de subiect de activitate din manualul prăjitorului de pâine:

Pâine prăjită

Prăjește pâinea până la coacerea perfectă folosind Pâinea de prăjit clasică.

Cerință prealabilă

Veți avea nevoie de: pâine feliată, prăjitor de pâine, o priză și unt (dacă doriți).

Pași de activitate

  1. Conectați mufa prăjitorului de pâine la o priză (Fig. 1).
  2. Introduceți pâine feliată în găurile de pâine situate în partea de sus a prăjitorului de pâine.
  3. Reglați temporizatorul pentru cât timp doriți să gătiți pâinea prăjită.
  4. Apăsați maneta în jos (Fig. 2).
  5. Când apare pâinea prăjită, scoateți-o de pe prăjitor și puneți-o pe o farfurie (Fig. 3).
  6. Folosiți întinderea dorită deasupra toastului (Fig. 4).

Rezultat

Pâinea prăjită este gata. Mănâncă-l înainte să se răcească!

Referințe

Subiectele de referință oferă informații suplimentare sau tehnice despre un produs. Puteți utiliza subiecte de referință pentru a furniza informații precum dimensiunile produselor, listele de echipamente, listele de piese, instrumentele necesare sau funcțiile unui produs sau serviciu.

Iată un exemplu de subiect de referință utilizat într-un manual pentru prăjitor de pâine:

Informații tehnice Classic Toaster

Dimensiuni, greutate și alte informații tehnice ale prăjitorului de pâine clasic.

Tabelul 1. Informații tehnice pentru prăjitorul de pâine clasic

Dimensiuni prăjitor de pâine:
Capacitate1 sau 2 felii
Ieșire pe oră30 de felii
Încărcare (kW)2.2
Dimensiuni (cm)36 x 21 x 22
Greutate (kg)4.25
Lățimea slotului28mm
MaterialeCapete din aluminiu turnat, corp din oțel inoxidabil

Mai jos avem două modele de prăjitoare de pâine: Classic Toaster ™ și Lightning Toaster ™. Coloana din stânga prezintă toate subiectele legate de ambele prăjitoare de pâine. Harta pentru fiecare model de prăjitor de pâine include numai informațiile relevante, astfel încât cititorul să nu aibă nevoie să pătrundă prin conținut fără legătură.

DITA folosește crearea tematică pentru a permite oportunități mai mari de reutilizare. De exemplu, aceste cinci publicații împărtășesc mai multe subiecte refolosite:

De asemenea, puteți reutiliza un anumit element de subiect, cum ar fi o notă. De exemplu, dacă există un disclaimer sau avertisment standard care este utilizat în toate manualele de produs, puteți scrie avertismentul o dată și îl puteți refolosi în alte documente.

Nivelul de reutilizare poate deveni foarte granular; paragrafele și chiar expresiile sau cuvintele pot fi analizate și reutilizate pe subiecte.

Există o mare diferență între reutilizarea conținutului și copierea și lipirea conținutului. Când copiați și lipiți conținut, există fișiere duplicate cu aceleași informații. Când informațiile sunt actualizate într-una, modificările nu sunt reflectate în celelalte fișiere. Reutilizarea, pe de altă parte, stochează conținut într-un singur fișier. Când sunt necesare actualizări, puteți actualiza că un fișier și alte fișiere care îl reutilizează sunt, de asemenea, actualizate. Acest lucru asigură o documentare consecventă și reduce timpul și efortul necesar pentru crearea și actualizarea conținutului.

DITA funcționează cu motoarele de publicare cele mai utilizate, cum ar fi WordPress, Mindtouch, Sharepoint și altele.

DITA separă stilul și formatarea de procesul de creare. Stilizarea se aplică atunci când documentele sunt publicate, utilizând pluginuri pentru a vă asigura că conținutul dvs. este frumos și coerent. Cu un clic pe un buton, puteți să vă publicați conținutul pe mai multe rezultate și să aplicați stilul specific fiecăruia. Când vă scrieți conținutul în DITA și publicați atât pe rezultatele mobile, cât și pe cele din browser, puteți aplica stilul pentru a oferi o experiență excelentă consumatorului în ambele rezultate.

Multe echipe de dezvoltare a conținutului lucrează în medii silențioase, ceea ce înseamnă că, dacă căutați o anumită informație, aceasta poate fi în fișierele unei persoane, astfel încât conținutul este greu de găsit și de colaborat.

Un CMS vă permite să faceți toate creațiile, revizuirea, comentarea, aprobarea și publicarea într-o bază de date centralizată. Conținutul este mai bine organizat și ușor de căutat, astfel încât să poată fi reutilizat în mai multe publicații.

Resurse DITA

Iată câteva resurse utile pentru învățarea, utilizarea și depanarea problemelor cu specificațiile DITA.