Що таке DITA і навіщо нам це потрібно?
«Ключ до розуміння принципу работиDITA- це розуміння того, як вона використовує топіки, карти і вихідні формати. Я все це поясню в деталях, але ось вам загальна картина: ви створюєте контент вDITA-топіках, іспользуетеDITA-карти, щоб визначити, які топіки потраплять в кожну з поставок, потім обробляєте ці карти з визначенням вихідного форматаDITAдля створення кінцевого результату ».
Багато хто з сьогоднішніх розробників методичних програм стикаються з великою дилемою.
В учнів є зовсім небагато часу, щоб зрозуміти і навчитися ефективно використовувати складні продукти і системи. Щоб запустити раціональні програми навчання, розробникам потрібно забезпечити учнів високоякісним навчальним контентом, налаштовується на конкретні ролі учня, і з можливістю своєчасної доставки його користувачеві. У той же час, бюджет на розвиток багатьох навчальних програм скорочується. Коротше кажучи, в учнів мало часу і грошей, щоб дізнатися те, що їм потрібно знати, а у розробників мало часу і грошей, щоб надати учням те, що тим потрібно.
Один із способів, за допомогою якого розробники можуть кардинально вплинути на дилему - це більш ефективне повторне використання контенту. Для багатьох розробників кращим способом для досягнення цієї ефективності є Специфікація навчального контенту (LTC), реліз якої запущений в версії 1.2 Дарвінівської архітектури типизированной інформації (DITA).
«Реліз чого?» - звичайно ж, запитають деякі Новомосковсктелі. Перш, ніж я відповім, дозвольте дати вам деяке уявлення «навіщо». У тестовому проекті DITA по специфікації LTC команда корпорації IBM вчилася повторного використання контенту за існуючим навчального курсу. Вони виявили, що 50% контенту курсу було скопійовано з документації по продукту. Використовуючи цю Специфікацію, вони змогли автоматизувати велику частину такого повторного використання, не тільки уникаючи витрат і можливих помилок ручного копіювання і вставки, а й забезпечуючи ефективний спосіб синхронізації оновлень контенту між документацією і навчальними матеріалами та заощаджуючи на вартості перекладу, що не переводячи один контент двічі. Чи не правда, варто дізнатися про це докладніше?
У цій статті я приведу опис і коротку історію DITA, поясню, як DITA сприяє ефективному і універсальному багаторазовому використанню різних типів кінцевих поставок контенту і обговорю, як Специфікація LTC фокусує переваги DITA на навчальні курси.
Чому Дарвінівська?
Багато людей, незнайомі з DITA, запитують: «Причому тут Дарвін в Дарвінівської архітектурі типизированной інформації?». В рамках своєї теорії природного відбору натураліст Чарльз Дарвін зазначив, що рослини і тварини успадковують риси своїх батьків. Подібно до цього, багато елементів в DITA успадковують атрибути від батьківських елементів. Мистецтво відображає природу.
DITA набула широкого поширення в світі технічної документації в таких компаніях, як Cisco, IBM (звичайно ж), Nokia і Oracle. Але впровадження DITA характерно не тільки для високих технологій. Боїнг і Управління охорони здоров'я ветеранів США вже вступили в комітети DITA, і я особисто допомагав перенести в DITA документацію по продукту ITT Fluid Technologies (виробник насосів і клапанів). Впровадження DITA відстало від світу професійного навчання, що, однак, не дивно, з огляду на початковий акцент DITA на технічних публікаціях, а не на навчальному контенті.
Ключ до розуміння принципу роботи DITA - це розуміння того, як вона використовує топіки, карти і вихідні формати. Я все це поясню в деталях, але ось вам загальна картина: ви створюєте контент в топіках DITA, використовуєте DITA-карти, щоб визначити, які топіки потраплять в кожну з поставок, потім обробляєте ці карти з визначенням вихідного формату DITA для створення кінцевого результату.
DITA-топіки мають певну структуру. Це зроблено для узгодженості між топіки, особливо топіки, розробленими різними людьми. Наприклад, топік-завдання може включати в себе в зазначеному порядку:
- Заголовок;
- пре-реквізити (то, що потрібно знати, мати або виконати вивчає до виконання завдання);
- дії завдання;
- очікуваний результат виконання завдання;
- пост-реквізити (що вивчає потрібно зробити після виконання завдання).
Ви можете змінювати цю структуру, як захочете. Наприклад, ви можете вимагати, щоб кожна задача мала назву, додаткову інформацію, дії і очікувані результати, але залишити включення пре-реквізитів і пост-реквізитів розробникам кожного окремого топіка.
DITA за замовчуванням забезпечує три основних типи топіків, кожен зі своєю власною структурою і правилами за замовчуванням. Ви можете використовувати концепт-топік для оглядів і пояснювальної інформації, топік-завдання для отримання інформації про виконання конкретних завдань і топік-виноску для докладної інформації, такої як специфікація системи, номери частин документа і синтаксис команд. DITA 1.0, 1.1 також надають універсальний топік, який розробники DITA можуть адаптувати під свої потреби. DITA 1.2 вводить додаткові типи топіків за замовчуванням, деякі з яких є частиною специфікації LTC. Я опишу їх пізніше в розділі «Що таке Специфікація DITA LTC».
До цього моменту, ви могли б подумати: «Ох, весь цей матеріал про DITA здається досить складним». Правда ж в тому, що є кілька дуже складних аспектів DITA, але основна механіка розробки топіків в DITA відносно проста. Малюнок 1 показує код DITA для простого топіка-завдання.
Зверну вашу увагу ще на пару особливостей даних малюнків.
По-друге, так само, як наведені приклади містять зображення, ви можете включати в DITA-топік практично будь-який мультимедіа -контент: аудіо, флеш-ролик і т.д. Як і в HTML, сюди можна включати гіперпосилання на інтернет-контент. Головне, про що варто пам'ятати - формат остаточної версії (з власного досвіду кажу, що GIF-анімація не дуже добре рухається в роздрукованому вигляді).
Щоб забезпечити цільову поставку для конкретного продукту, аудиторії або цілі, використовуються DITA-карти. DITA-карта являє собою список покажчиків на набір конкретних топіків, що визначає, які саме топіки повинні бути включені в поставку. Також карта визначає порядок та ієрархію топіків і забезпечує навігацію, як наприклад, зміст і перехресні посилання між топіки в складі остаточної версії.
Карти можна створювати на будь-якому етапі роботи з DITA. Деякі розробники використовують карти як інструмент планування і відстеження перед створенням топіків, а інші створюють карти вже після розробки топіків. У будь-якому випадку, і закінчені карти, і топіки необхідні для створення остаточної поставки.
В реальному середовищі DITA-топіків, що відносяться до багатьох картах, буде набагато більше, ніж показано в прикладі. Як правило, більше половини топіків використовуються різними картами.
Нагадаємо, що специфікація DITA 1.2 визначає топік DITA як «озаглавлений блок інформації, який може бути зрозумілий окремо від інших блоків і використовується в різних контекстах». Карти допомагають зрозуміти, чому так важливо, щоб контент мав нейтральний контекст у всіх можливих топіках, де це можливо. Наприклад, якщо ви використовували зв'язку: «Раніше ви вивчили ...» або «У топіку ABC ...», то тим самим встановили залежність між двома топіки. Але в разі, якщо в одній з поставок інший топік відсутня або йде в іншому порядку, ви направите людей до невірного або зовсім неіснуючого контенту. Якщо вам все-таки необхідно використовувати текстові зв'язки між топіки, є способи зробити це, але це вже не відноситься до даної статті.
Незважаючи на те, що вказує Малюнок 3, зовсім не обов'язково включати топік в карту. Топіки і карти DITA можуть активно використовувати метадані для обробки даних за заданими умовами (фільтрації), забезпечуючи можливість використання різних варіантів топіка при обробці карти. Припустимо, у нас є три топіка «О (чому-небудь)», що містять абсолютно ідентичний контент, крім вступної фрази. Ми можемо створити єдиний топік «О (чому-небудь)» і включити в нього три різні варіанти вступних фраз, а потім застосувати метадані, щоб вказати, яка з фраз відповідає кожному з продуктів. Звернення до метаданих в карті визначає, яку з фраз слід включити в текст в кожному випадку.
Карти можуть вказувати не тільки на топіки, але і на інші карти. Цю можливість можна використовувати, наприклад, для створення карти кожного уроку в курсі; потім використовувати іншу карту, щоб вказати, які уроки потрібно включити в курс і в якій послідовності. Так само, як і з топіки, якщо в карті щось змінюється, зміни відображаються у всіх картах, які на неї посилаються.
Слід визнати, що Малюнок 3 показує дуже простий приклад; я чув, що IBM на даний момент підтримує понад мільйон DITA-топіків і хто знає, скільки карт. Але навіть такий приклад ілюструє багатство можливостей і універсальність DITA. А вихідні формати, про які піде мова далі, ще більше розширюють ці можливості.
Оскільки DITA використовує семантичне тегірованіе, а не теги форматування, саме вихідні формати контролюють, як буде виглядати поставка. Багато розробники DITA модифікують надані вихідні формати для відповідності шаблонах, розробленим раніше в Microsoft Word або Adobe FrameMaker. Модифікація формату PDF особливо хитромудрі, але існує безліч інструментів, які допомагають спростити цю роботу.
А що про тих системах управління контентом?
Часто піднімається питання використання систем управління контентом (CMS) спільно з DITA. CMS забезпечує різноманітність корисних функцій, таких як контроль джерела і огляд управління DITA-топіки, картами і вихідними форматами. У той час як багато DITA-інструменти можуть вигідно співпрацювати з СMS, її наявність не обов'язкова. CMS можуть бути дорогими в реалізації, так що ретельно проаналізуйте свої конкретні потреби.
Оцініть неймовірну універсальність кожного окремого DITA-топіка. Карти можуть включати в себе топіки, визначати порядок та ієрархію топіків, включати тільки релевантний певного продукту, цілі або аудиторії контент, і в кінцевому підсумку створювати поставку, що містить цей топік, в різних вихідних форматах. Якщо щось змінюється в топіку, то це відіб'ється і на остаточній версії.
На початку статті я згадував Специфікацію DITA для навчального контенту (LTC) і то, як IBM застосовує її для автоматизації повторного використання контенту, його синхронізації з документацією продуктів і економії на перекладі.
Специфікація - це функція, що забезпечує розробникам DITA ще більшу універсальність. Три базових типу топіків, доступних в DITA (концепти, завдання і виноски), добре працюють з технічними публікаціями, але не завжди зручні для поставок навчального контенту. Для таких поставок можуть знадобитися спеціальні типи топіків, призначені для оцінки навчання і резюме матеріалів, а також особливі теги, створені для навчального контенту.
Комісія заснувала Специфікацію на кращих методичних розробках, що застосовуються в індустрії навчання, але Специфікація Неможливо сфокусуватись на якійсь конкретній навчальній моделі.
LTC Специфікація пропонує велике розмаїття для розробників навчального контенту. Вона включає типи топіків, спеціально створених для планів навчання, оглядів, інформаційних матеріалів, резюме, оцінок; а також численні спеціальні теги, призначені, наприклад, для приміток інструктора, елементів оцінки (закритих і відкритих питань, питань з вибором єдиного варіанта і так далі). Також Специфікація підтримує специфічні для навчання метадані (наприклад, час навчання та рівень складності).
У зв'язку з характером успадкування DITA, навіть якщо ви або інші розробники створюють DITA-топіки поза LTC Специфікації, ви все ж можете використовувати топіки LTC і не LTC спільно. Наприклад, ви можете створити карту уроку, яка починається з огляду LTC, потім послатися на дещо не-LTC топіків з документації по продукту, а потім закінчити резюме і оцінкою з LТС. У DITA основні поняття, які я описав в цій статті, можуть бути застосовані до LTC Специфікації; так, наприклад, ви можете будувати уроки або цілі курси з використанням DITA-карти, а також генерувати кінцеві поставки з використанням вихідних форматів.
Отже, для чого ж нам потрібна DITA і Специфікація LTC? Припустимо, що ви працюєте з великими обсягами навчального контенту, копіюючи контент з різних джерел, або працюєте з великими командами, потребуючи в кращій узгодженості контенту. В цьому випадку DITA і Специфікація LTC можуть стати для вас відмінним рішенням проблеми того, що в учнів мало часу і грошей на навчання, а у вас - на те, щоб надати їм все необхідне. Якщо поява Специфікації LTC призведе до того, що DITA 1.2 пошириться серед розробників навчання так само швидко, як DITA 1.0 і 1.1 поширилися в світі технічної документації, то, ймовірно, незабаром ваше начальство зацікавиться, а чи не ввести в вашої організації DITA.
З часів появи DITA багато організацій, що використовують DITA для технічної документації, зрозуміли, наскільки це вигідно в плані економії часу і грошей, а заодно і підвищення якості та універсальності. Також вони виявили й інші переваги роботи з DITA, як наприклад більшу кількість можливостей співпраці в середовищі розробки.
З введенням Специфікації LTC всі ці переваги стали доступні і розробникам навчання. Крім того, Специфікація пропонує можливості для співпраці між командами, що займаються навчанням і документацією. Я розумію, що зазвичай такі команди працюють окремо, так і одна ця технологія не задовольнить всім підходам до роботи з контентом, але все ж можливості застосування DITA в бізнесі досить привабливі. Чи легко розгорнути DITA? Ні. Чи окупиться це з часом? Якщо все правильно спланувати і виконувати, можливо.
Посилання та джерела