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

Обзор MadCap Flare 10 (часть 1)

12.03.2014

00Мы начинаем серию статей, составляющих обзор вышедшей на прошлой неделе новой версии продукта для технического документирования компании MadCap – Flare 10. Рассказывает о новых функциях и преимуществах Нэйл Перлин (Neil Perlin), генеральный директор компании Hyper/Word Services, имеющий 35-летний опыт работы техническим писателем, 29-летний опыт консультанта и тренера, а также являющийся сертифицированным пользователем MadCap и автором нескольких обзоров продуктов компании MadCap.В начале обзора Нэйл объясняет особенности адаптивного вывода контента и роль HTML5 в публикации контента и его обнаружении поисковиками.


Flare является относительным новичком в мире технической документации, он дебютировал в 2006 году. Но компания MadCap основательно расширила его в десятой версии, вышедшей на прошлой неделе (4 марта 2014 г.) и предлагающей новые функции и множество усовершенствований.

В этом обзоре я расскажу об основных функциях — адаптивном выводе документа, основанном на HTML5, слайд-шоу, системе помощи Eclipse и экспорте проекта, затем рассмотрю моменты, которые считаю основными усовершенствованиями.

HTML5 – Публикация и адаптивный вывод

Чтобы полностью оценить расширение основного функционала, доступное в MadCap Flare 10, вам может понадобиться краткая справка по HTML5 и адаптивному выводу документа.

Принципы HTML5

HTML5 является преемником XML и ранних версий HTML. Это язык программирования, а также, в Flare 10 (и Flare 9), модуль вывода в браузер (browser based output). Вы можете по-прежнему использовать WebHelp для вывода в браузер, но HTML5 имеет некоторые преимущества, которые могут заставить вас задуматься над использованием WebHelp.

  • Пригодность для веб-поиска сканерами/«пауками»/ботами. WebHelp прекрасно работал годами, но у него есть проблема, которая была незаметна, пока не появились поисковые агенты («пауки»). WebHelp использует старую фреймовую технологию для создания «лоскутного» (paned) вида выгруженного документа, но фреймовая структура не позволяет «паукам» погрузиться в выгруженные документы глубже домашней страницы. Результатом является то, что онлайн-контент, распространяемый как WebHelp, не обнаруживается поисковиками и не отображается в списке результатов поиска. Другими словами, пользователи не могут найти ваш контент с помощью публичных поисковых систем. Это может быть не существенным, если ваш выходной контент находится за брандмауэром или экраном входа в систему, и, значит, доступен только для клиентов. Но если ваша компания придерживается более открытой стратегии с общедоступным контентом, то фреймовая структура — это стратегическое ограничение. HTML5 исправляет это. Выходной документ по-прежнему выглядит так же, как при использовании фреймовой структуры, но она не используется – таким образом, пользователи могут найти ваш выходной документ, используя Google и т.д.
  •  Поддержка CSS3. Это расширение стандарта CSS (Каскадные таблицы стилей) добавляет возможности и гибкость для форматирования под современные браузеры.
  • Поддержка «гибридных» мобильных приложений, которые основаны, в частности, на HTML5. Flare не выводит гибридные приложения, но код HTML5, который он выводит, образует часть фундамента для таких приложений. Другими словами, вывод HTML5 это шаг навстречу гибридным приложениям.

Принципы адаптивного дизайна

Необходимость адаптивного дизайна возникла в связи с тем, что новые устройства с различными размерами и разрешениями экрана продолжают появляться. Вместо того, чтобы оптимизировать наш вывод документов для настольных ПК, мы должны оптимизировать его для множества смартфонов и планшетов с различными характеристиками. Мы могли бы оптимизировать вывод для нескольких устройств, имеющихся на сегодняшний день, но это вскоре станет слишком дорого, так как новые устройства продолжают появляться.  Но мы все еще хотим, чтобы наш выходной документ хорошо выглядел на любых устройствах с разными экранами. Решение проблемы – «адаптивный вывод».

Адаптивный вывод позволяет контенту автоматически изменять свой дизайн в соответствии с характеристиками устройства, на котором он отображается — так называемый девайс-агностицизм (device-agnosticism). Такой вывод в HTML5 позволяет изменять дизайн контента в зависимости от того, где он отображается – на смартфоне, планшете или ПК. К примеру, на следующем рисунке показан адаптивный вывод на стандартный монитор настольного ПК. Обратите внимание на логотип MadCap на чёрном фоне вверху слева и на навигационные панели слева.

1 - Flare-10-desktopНа следующем рисунке показан вывод из того же проекта в меньшее окно браузера, что имитирует планшет. Обратите внимание на новую позицию логотипа и скрытые теперь панели навигации.  Это изменение привязано к контрольной точке. Размеры устройств, при которых вступают в силу различные настройки оболочки, настраиваются в редакторе оболочек HTML5 (Skin Editor).

2 - Flare-10-tablet

На рисунке ниже показан вывод из того же проекта в окно браузера еще меньшего размера, чтобы имитировать смартфон. Обратите внимание на отличающийся цвет фона иконки. Я связал это изменение с контрольной точкой «Еще меньше» и определил его, используя редактор оболочек HTML5.

3 - Flare-10-small-device

Тот факт, что дизайн отличается в зависимости от устройства, может показаться не таким уж важным. Мы можем добиться этого, создавая различные выводы, каждый из которых предназначен для определенного устройства. Но примеры выше взяты из одного вывода, который автоматически приспосабливает себя к параметрам устройства, на котором выводится. Вам по-прежнему необходимо определить различные настройки оболочки и контрольные точки, в которых изменяется дизайн, но вы делаете это один раз для одного вывода.

Я считаю адаптивный вывод наиболее существенной функцией в Flare 10, потому что он представляет собой основополагающее изменение в работе технической коммуникации, сравнимое с эффектом от появления онлайн помощи в середине 80-х, перехода на HTML в 1997 и поддержки мобильных устройств, которая появилась в программных продуктах, таких как Flare несколько лет назад. С адаптивным выводом техническая коммуникация подходит к тому, чтобы публиковать на любые устройства, включая мобильные, но не ограничиваясь ими.

(продолжение следует)

Источник: MadCap Flare 10 – A Review

Тэги: , , , , ,

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

Облако тегов