Всё для технического документирования
+7 (925) 328-76-00
Разработка технической документации
Курсы для технических писателей
Программное обеспечение

Проблема документирования: является ли структурированный контент залогом значительных улучшений?

24.08.2016

0110 обстоятельств для внедрения DITA на предприятии

Даже сравнительно небольшая компания или организация генерирует множество документов. Когда вы сталкиваетесь с более крупным контекстом, то имеете дело с тысячами или даже миллионами страниц документации, отчётов, маркетинговых материалов, регулярными документами о соответствии законодательству, презентациями… ошеломляющий объем контента. Этот контент со временем станет огромным капиталом и будет рассматриваться как значимое, ценное имущество компании. Почему? Потому что этот контент — ваша первая линия взаимодействия с клиентами, он позволяет таким группам, как HR и поддержка пользователей работать гладко и эффективно, и он представляет собой одновременно интеллектуальную собственность и опыт вашей организации или компании. Но также очень часто он расположен в таких неструктурированных средах для авторинга как файлы Microsoft Word, что делает практически невозможным централизованно управлять этими фондами.


К счастью, есть централизованное решение, основанное на открытых стандартах, масштабируемое и очень экономичное. Построенное на стандарте Darwin Information Typing Architecture (DITA), разработанном IBM для решения их собственных проблем с документацией, это решение представляет собой залог значительных улучшений относительно устаревших моделей создания и управления находящегося в эксплуатации контента, которые сегодня всё ещё широко используются. Когда DITA интегрируется с окружением для авторинга/управления (компонентная система управления контентом, или CCMS), этот стандарт предлагает решение с заделом на будущее решение буквально всех ваших проблем, связанных с управлением документацией. Десять обстоятельств, указанные ниже, показывают масштабируемость, гибкость и значительную экономию средств при переходе на DITA CCMS.

1. Контроль версий

В DITA у вас нет множества версий отрывка контента. Когда вам необходимо «скопировать» контент для другого использования или распространить его, вы на самом деле не копируете этот отрывок. Вместо этого вы указываете на него в базе данных. Любые изменения, комментарии или редактура, производимые с этим отрывком, отражаются в каждом его применении. Это устраняет затратные по времени процессы копирования/вставки/отправки по почте/отслеживание изменений, которые, как результат, порождают множество несвязанных версией контента. Когда у вас есть множество версий контента, вы сталкиваетесь с проблемами контроля версий, т.к. изменения вносятся в различные версии. Это больше не проблема при использовании DITA.

2. Перевод

Влияние компонентной системы управления контентом (CCMS) для DITA на процесс и стоимость перевода может быть очень серьёзным. И этот коэффициент окупаемости может быть точно измерен, потому что стоимость внешних поставщиков перевода до и после внедрения DITA легко отследить с помощью счетов на их услуги. Влияние DITA на стоимость переводов и локализации основано на её способности упрощать процесс перевода. Когда вносились изменения в уже переведённый документ, обычно целый документ отправлялся переводчику. Переводчик запрашивал цену за количество слов, которые изменились, а также брал деньги за поиск по документу изменений в контенте. При использовании DITA при процессе перевода переводчику отправляются только изменённые топики. Плюс к этому, учитывая тысячи документов на множестве языков, двойная работа по переводу одного и того же текста была обычным делом и приводила к увеличению затрат. Эмбер Своуп (Amber Swope) исследует финансовые последствия процесса перевода в DITA в этой статье в блоге Writing Assist. Она отмечает, например, что «производственная компания, внедрившая DITA после выхода на глобальный рынок, что потребовало перевода на 14 новых языков, смогла сэкономить более $ 225 000 в течение первых трёх месяцев своего пилотного проекта на одном наборе документации».

3. Публикация

Публикация контента в таких неструктурированных форматах, как Microsoft Word, ограничивает ваши возможности для простой и одновременной публикации контента в широкий набор носителей, которые сейчас используются для потребления информации. Всего несколько лет назад было достаточно внести добавление в базу знаний или опубликовать в PDF и на печать, но сегодня люди ожидают представления информации на множестве устройств, от мобильных до настольных компьютеров. Посмотрите на Интернет вещей (IoT). Интернет вещей развивается в сторону использования потенциала включения цифровой документации непосредственно в продукт или приложение, связанное с продуктом. В качестве примера можно привести автомобиль Tesla, который управляется встроенной программной системой, которая может обновляться через Интернет, добавляя такие возможности продукта как вождение без рук. Документация, включая обучение владельца, включается в это обновление и распространяется в каждую машину. Этот тип сценариев будет становиться всё более очевидным в будущем, и неструктурированный процесс создания документации не сможет обеспечить эти потребности по мере появления. Прочитайте об обновлении прошивки и о том, как Tesla доставляет свою документацию, на их сайте. Владельцы также могут загрузить мобильное приложение для удалённого мониторинга и контроля машины с телефона. Это приложение — ещё один пример носителя, который требует возможности публикации в реальном времени.

4. Возможность поиска и управление

Если у вас есть сотни или тысячи документов во множестве форматов и вам необходимо определить, существует ли контент на определённую тему, то что вы делаете? Вы совершаете по нему поиск. При использовании DITA они все расположены в центральном репозитории и тэгированы стандартизованными метаданными для таких вещей как автор, дата создания, тема, тип топика — практически любая применимая категория объекта. Это означает, что вы можете осуществлять поиск очень разными способами, например, «все задачи, связанные с изучением ПО XYZ v.2.1, написанные до 2012 года». В большинстве приложений DITA это реализовано с помощью фасетного поиска, когда вы можете выбрать из списка фильтров для уточнения поиска. Это также позволяет осуществлять более эффективное управление контентом, т.к. вы организуете и доставляете контент быстро и точно с помощью инструментов поиска.

5. Авторинг, основанный на топиках

Написание контента в виде отрывков, известных как топики — базовое отличие между DITA и таким программным обеспечением для неструктурированного авторинга, как Word. Когда вы разбиваете каждый документ на топики и назначаете типы и метаданные для каждого отрывка, то вы теперь можете перевести вашу документацию в данные, которые можно использовать множеством различных способов. Существует некоторая кривая обучения для писателей, не знакомых с этой методологией, но когда они «возьмут» это, пути обратно уже не будет. Сара О’Кифи (Sarah O’Keefe) из Scriptorium Publishing исследует коэффициент эффективности авторинга, основанного на топиках в DITA (с цифрами) в этой презентации на SlideShare.

6. Повторное использование

Есть ли успехи в вашей компании по борьбе с дубликатами при создании документации? Различные отделы создают документы, содержащие одинаковые разделы, такие как «Предупреждения по безопасности» или инструкции по выполнению задач, одинаковые для различных моделей продуктов в продуктовой линейке? Это может привести к большим затратам, но при использовании устаревших способов создания информации практически невозможно отследить эти дубликаты. Авторинг на базе топиков в DITA позволяет совершать эффективное повторное использование контента намного более просто, так как каждый топик тэгирован по типу и метаданным. Это, в свою очередь, позволяет осуществлять более эффективный поиск и позволяет создать библиотеку отрывков (топиков) контента для поиска по ним и выбора для повторного использования. Каждый отрывок может быть распространён, рецензирован и отредактирован отдельно со всеми изменениями, появляющимися во всех глобальных экземплярах повторного использования этого отрывка. Эта возможность обновлений приводит к значительной экономии времени, и при этом гарантирует, что документация отражает все изменения в реальном времени, при одновременной разработке продукта и сервиса. Повторное использование также играет важную роль при публикации, т.к. вы можете легко трансформировать и компилировать контент, с использованием карт, что гарантирует, что публикация оптимизирована для каждого формата. В статье в CIDM Бет Поллок (Beth Pollock) и Андреа Разерфуд (Andrea Rutherfoord) из Citrix Systems полагают, что повторное использование контента с помощью DITA сэкономило их команде 1800 дней, или работу семи эквивалентов полной занятости (FTE) за первые пятнадцать месяцев после внедрения.

7. Обновления

Необходимо изменить номер запчасти по множеству руководств пользователя, в разделе техподдержки, на веб-сайте и в печатной документации? Сделайте это изменение один раз в DITA, и в каждом месте, где повторно используется этот контент, он обновится. Нет шансов для возникновения устаревшей документации.

8. Масштабируемость

Сохранение тысяч документов Word во множестве мест абсолютно не масштабируемо. Управление таким объёмом документации связано со множеством ручной работы и приводит к ошибкам. Поиск информации в этом стоге сена практически невозможен. DITA была разработана IBM для их собственного управления документацией, чтобы решить именно эти проблемы для беспрецедентного масштаба (60+ миллионов документов, 40 языков). Осознавая, что они решили очень большую проблему, с которой сталкивается практически каждый бизнес или организация, они отрелизили базу данных DITA в виде открытого стандарта в 2005 году. Она была разработана, чтобы стать нечто большим. IBM предлагает всестороннюю (и читаемую!) документацию и историю DITA на своём сайте DeveloperWorks.

9. Производственный процесс

В обычных неструктурированных средах даже процесс авторинга часто устроен непродуманно. Назначение, написание, рецензирование, редактирование, рерайт, редактирование, утверждение, публикация — по функциям и различного уровня иерархиям. DITA формализует этот процесс с помощью встроенных инструментов, чтобы сохранить течение работы без узких горлышек, вызываемых проблемами доставки («Я знаю, что документ где-то в электронной почте…»). Назначение задач, комментирование в тексте, рецензирование и утверждение и т.д., — всё в одном приложении. Облачные DITA-системы идут даже дальше, позволяя каждому с доступом в Интернет и безопасным логином запрыгнуть в процесс из любого места. Менеджеры могут легко наблюдать за процессом, чтобы определить статус и решить любые проблемы.

10. Открытый стандарт

Открытые стандарты должны подчиняться определённым требованиям независимо от того, кто их использует. DITA основана на XML, который сам по себе является открытым стандартом. База данных DITA и архитектура поддерживаются и обновляются комитетами, в которые входят пользователи, которые голосуют за апгрейды. Форматы файлов свободно перемещаются между приложениями, которые могут считывать XML, а это означает, что ваша документация не заточена в закрытых форматах.

Если вы сталкиваетесь с некоторыми из этих ситуаций при создании документации и её управлении в своём мире, переход к созданию и управлению контентом на основе DITA может вам помочь сохранить время, деньги и позволит лучшим образом использовать ценные активы вашей компании, создающиеся каждый день.

Источник: The Documentation Problem: Is Structured Content An Order of Magnitude Improvement?

Тэги: , ,

< Вернуться к списку публикаций

Облако тегов