Публикации
Зачем мне нужна DITA? (часть 2)
25.04.2014
Мы завершаем статью, рассказывающую о преимуществе DITA над другими средствами авторинга. Но не считайте, что мы навязываем эту среду всем нашим читателям. Реалии таковы, что DITA не всегда может окупиться или стать самым оптимальным решением для каждого. Следите за нашим блогом, мы постараемся привести плюсы и минусы лучших из существующих решений.
DITA повышает удобство использования
DITAпредставляет переход от главо- и книгоориентированного авторинга к топикоориентированному, где каждый фрагмент информации является ясным и полным сам по себе. Кроме того, каждый фрагмент или топик имеет четкую цель. Ядро DITA включает в себя различные типы топиков, каждый написан, чтобы выполнить конкретную цель пользователей: концепт-топик для объяснения, топик-задача для инструктажа и топик-сноска для подробной информации.
Разделение контента на отдельные, часто используемые, но чёткие топики делает его более доступным для поиска. Пользователи могут перемещаться прямо к необходимой им информации, читать только соответствующую информацию (потому что остальное отбрасывается), а затем заниматься своими делами.
Зачем мне нужна DITA? (часть 1)
23.04.2014
Мы снова вернулись к одной из самых обсуждаемых тем нашего блога – DITA и важность её внедрения. Давайте ещё раз вспомним все преимущества этого стандарта.
Дарвиновская Архитектура Типизированной Информации (DITA) является стандартом на базе XML, который используется в основном для технической и всё чаще и для других типов документации. Мы уже представляли вам статью «Что такое DITA и зачем нам это нужно?». Мы подробно остановились на «что», а теперь хотели бы ещё раз подчеркнуть «зачем». И это вопрос, который вам нужно задать себе, если работа над созданием технического контента – часть вашей ежедневной работы.
Ответ обманчиво прост: Никуда от этого не денешься; если вы не применяете DITA как стандарт документации, вы работаете гораздо медленнее и менее эффективно, чем должны бы.
Требует ли внедрение DITA времени, усилий и знаний? Да, это так. И тогда вы сможете пожинать плоды в течение следующих… нуууу… в течение всего обозримого будущего. Читать дальше…
Рецензия на книгу «Каждая страница – это первая страница». Добавьте её к арсеналу
28.03.2014
В 2013 году Марк Бейкер выпустил интересную и, несомненно, полезную для многих книгу «Каждая страница – это первая страница». Представляем вам рецензию на данную книгу, сделанную Рейчел Хотон, техническим писателем с более чем 14-летним стажем работы.
С большими ожиданиями я взяла свой ??собственный подписанный экземпляр книги Марка Бейкера «Каждая страница – это первая страница» на мероприятии LavaCon 2013 года. Я даже взяла вторую копию для местного отделения научно-технического центра, чтобы разыграть его в качестве приза на следующем заседании. Потом меня попросили дать рецензию на эту книгу для TechWhirl.
Шумиха вокруг этой книги на LavaCon и в других средствах массовой информации не обманула моих ожиданий. Я была рада видеть, что автор подтвердил мои давнишние предположения – пользователи больше не хотят смотреть или что-то искать в справке или документации. Они хотят искать в Google, причём искать не только вашу имеющуюся документацию, но и опыт других людей по данной проблеме.
Марк разделил свою книгу на три части: контент в веб-контексте, характеристики топиков «каждая страница – это первая страница» и написание топиков «каждая страница – это первая страница»
Обзор MadCap Flare 10 (часть 3)
17.03.2014
Мы заканчиваем обзор нового продукта компании MadCap – Flare 10. Мы уже рассмотрели основные преимущества продукта, теперь коснёмся более мелких, но тем не менее важных и полезных нововведений.
Дополнительные улучшения
Этот релиз включает многочисленные мелкие улучшения. Невозможно сказать, какие из них наиболее важны для разработчиков, поэтому перечисляю их в неопределённом порядке:
- Возможность задания условий размещения отдельных объектов на карте гиперсвязей документа. Задание условий размещения является основой составляющей единого источника, но неспособность располагать объекты на карте гиперсвязей означает, что либо вы не использовали карты гиперсвязей для единого источника, либо создавали несколько версий каждой карты и задавали условия для каждой, добавляя себе работы. Если вам в выводе единого источника нужны карты гиперсвязей документа, возможность задания условий размещения объектов на карте станет приятным для вас дополнением. Читать дальше…
Обзор MadCap Flare 10 (часть 2)
14.03.2014
Продолжаем публикацию обзора продукта Flare компании MadCap. Сегодня мы узнаем о том, насколько могут быть полезны слайд-шоу, зачем нужна функция Экспорт проекта, а также о том, каким образом компания вынуждает пользователей переходить с trial-версий на лицензионные.
Поддержка в Flare вывода HTML5 и адаптивного вывода
В Flare 9 была добавлена поддержка вывода HTML5, весьма удачно встроенная в интерфейс. Некоторые опции были названы по-другому и располагались не там, где их эквиваленты для WebHelp, но все равно оказались под рукой. В Flare 10 добавили новый, более лёгкий в использовании, редактор оболочек HTML5 и адаптивный вывод в виде набора новых вариантов в редакторе оболочек HTML5 и редакторе целевых файлов. Вы включаете адаптивный вывод на дополнительной вкладке редактора целевых файлов, устанавливаете контрольные точки на вкладке настройки редактора оболочек HTML5 и устанавливаете различные другие параметры отображения в редакторе оболочек HTML5.
Обзор MadCap Flare 10 (часть 1)
12.03.2014
Мы начинаем серию статей, составляющих обзор вышедшей на прошлой неделе новой версии продукта для технического документирования компании MadCap – Flare 10. Рассказывает о новых функциях и преимуществах Нэйл Перлин (Neil Perlin), генеральный директор компании Hyper/Word Services, имеющий 35-летний опыт работы техническим писателем, 29-летний опыт консультанта и тренера, а также являющийся сертифицированным пользователем MadCap и автором нескольких обзоров продуктов компании MadCap.В начале обзора Нэйл объясняет особенности адаптивного вывода контента и роль HTML5 в публикации контента и его обнаружении поисковиками.
Flare является относительным новичком в мире технической документации, он дебютировал в 2006 году. Но компания MadCap основательно расширила его в десятой версии, вышедшей на прошлой неделе (4 марта 2014 г.) и предлагающей новые функции и множество усовершенствований.
В этом обзоре я расскажу об основных функциях — адаптивном выводе документа, основанном на HTML5, слайд-шоу, системе помощи Eclipse и экспорте проекта, затем рассмотрю моменты, которые считаю основными усовершенствованиями.
Что такое DITA и зачем нам это нужно?
05.02.2014
Представляем вам важную и познавательную статью Криса Бенца (Chris Benz), посвящённую DITA и её спецификациям. В ней мы объясним принципы работы стандарта DITA, дадим определение основным терминам и понятиям и попытаемся ответить на вопрос: «Зачем всё это нужно?». Обратите внимание, что статья написана в 2010 году, но сведения, изложенные в ней, актуальны и сейчас, поэтому мы при переводе проверили и актуализировали некоторую информацию и ссылки на стандарты. Также мы предложили свои варианты перевода основных терминов, относящихся к стандарту, и если курсор мыши расположить над подчёркнутыми в тексте терминами, то во всплывающей подсказке отобразится определение.
Многие из сегодняшних разработчиков методических программ сталкиваются с большой дилеммой.
У учащихся есть совсем немного времени, чтобы понять и научиться эффективно использовать сложные продукты и системы. Чтобы запустить рациональные программы обучения, разработчикам нужно обеспечить учащихся высококачественным обучающим контентом, настраиваемым под конкретные роли ученика, и с возможностью своевременной доставки его пользователю. В то же время, бюджет на развитие многих обучающих программ сокращается. Короче говоря, у учащихся мало времени и денег, чтобы узнать то, что им нужно знать, а у разработчиков мало времени и денег, чтобы предоставить учащимся то, что тем нужно.
Один из способов, с помощью которого разработчики могут разрешить эту дилемму – это более эффективное повторное использование контента. Для многих разработчиков лучшим способом для достижения этой эффективности является Спецификация обучающего контента (L&TC), релиз которой запущен в версии 1.2 Дарвиновской архитектуры типизированной информации (DITA).
Техническое писательство и DITA
31.01.2014
Сегодня объектом нашего внимания стала познавательная статья Сьюзен Бодник, рассказывающая, что же такое система DITA, о которой мы уже упоминали в наших публикациях.
Процесс создания технических документов, таких как руководства пользователя, постоянно развивается, по мере того, как становятся доступными новые технологии. Потребители могут получить доступ к информации в различных формах, в том числе через веб-сайты, форумы поддержки, системы баз знаний, списки часто задаваемых вопросов и многое другое. DITA может помочь писателям в решении проблемы создания технических документов в непрерывно усложняющихся условиях глобального рынка.
easyDITA: Решение для создания и управления контентом организации (часть 3)
29.01.2014
Мы заканчиваем публикацию, посвящённую инструменту easyDITA. Сегодня мы узнаем о возможностях, предоставляемых easyDITA для налаживания обратной связи с клиентами, и рассмотрим дополнения, выпущенные в последнем релизе.
Расширение структурированного авторинга и многоканальной доставки контента за пределы технических коммуникаций
Так как структурированный авторинг продолжает развиваться, организации ищут возможность создавать, повторно использовать, обновлять контент и управлять им в различных функциональных областях, преследуя одну цель: улучшение качества обслуживания клиентов. easyDITA может отображать обратную связь от клиентов прямо в самом контенте, принимая предложения по разработке контента.
Социально ориентированная документация продукта собирает ценную информацию о том, какой контент хотят клиенты, и помогает выявлять и удалять материал, который является неясным. Точный и адаптивный контент повышает удовлетворенность клиентов.
easyDITA: Решение для создания и управления контентом организации (часть 2)
27.01.2014
Мы продолжаем обзор easyDITA – средства, призванного упростить процессы хранения, передачи и повторной обработки контента для писателей и редакторов. easyDITA также предоставляет системы совместной работы над контентом, широкий выбор средств публикации и широкие возможности интеграции с другим ПО.
Техническая документация является сложным, постоянно меняющимся направлением. Одним из преимуществ DITA является то, что она разбивает информацию на модули, так что при необходимости данные можно изменить в одном модуле, а затем они автоматически обновятся в каждом документе, использующем этот модуль. Без специальных технологий сложно эффективно управлять этими «компонентами». Поэтому easyDITA сочетает в себе средства разработки с полной системой управления контентом (CCMS) для обеспечения полной функциональности, необходимой для писателей, чтобы хранить, находить и повторно использовать контент.
CCMS полностью интегрируется в хранилище единого источника, в том числе включая изображения и мультимедийные файлы. Система работает в родной базе данных XML, которую можно организовать как на серверах заказчика, так и в облаке. Размещение easyDITA в облаке открывает возможности для сотрудничества в рамках всей организации без дополнительных затрат, возникающих при привязке лицензии на программное обеспечение к конкретному компьютеру, а также на развёртывание программного обеспечения. Владельцы контента назначают задачи авторам, рецензентам и ответственным за выпуск контента в автоматизированной системе документооборота easyDITA, которая позволяет управлять рецензиями отдельно от модификации контента, а также ведёт журнал регистрации всех действий при совместной работе. Кроме того, контент можно более эффективно локализовывать с уверенностью, что все языки готовы к работе одновременно, а это может уменьшить время выхода на рынок.