КомпанияУслугиОбучениеСервисы

MadCap Flare: система для разработки технической документации на основе единого источника

Версия для печати

Основные возможности и преимущества

Ирина Шапошникова, Topcon Positioning Systems

Выступление на семинаре 18.12.2008.

Почему именно Flare?

Добрый день. Меня зовут Ирина Шапошникова, я — технический писатель компании Topcon Positioning Systems. Я расскажу вам вкратце о программном продукте компании MadCap, который называется Flare.

MadCap — американская компания, на рынке существует достаточно давно, но, к сожалению, практически неизвестна в России. Я впервые о ней услышала на конференции технических писателей, которая проходила в сентябре этого года в Эдинбурге. Одним из организаторов конференции выступила возможно знакомая вам компания WinWriters, недавно переименовавшаяся в Writers UA (User Assistance), вторым — английская компания Matthew Ellison Consulting, специализирующаяся на организации тренингов, конференций, семинаров и, соответственно, оказании консалтинговых услуг в области технического документирования и смежных областей.

Конференция была очень насыщенной. Там освещались вопросы из самых разных областей нашей с вами работы. В том числе:

  • общий обзор технологий хелп;
  • разработка документов хелп с точки зрения эргономики пользователя;
  • особенности работы с XML;
  • обзор технологий Wiki;
  • советы тем, кто пишет на английском по формулированию мыслей и донесению оных до пользователя;
  • и, конечно, обмен опытом — кто как и на основе чего создавал свои порталы для саппорта и хелпа.

Также свои семинары проводили представители компаний, разрабатывающих сопутствующее программное обеспечение.

Материалы конференции (на английском языке) выложены на сайте www.uaconference.eu.

Европейские конференции проводятся раз в год осенью, достаточно камерно — в этот раз было порядка 60 участников. А в Америке каждый год весной проводится более широкомасштабное мероприятие, человек на 300. Следующее пройдет в Сиэттле, с 29 марта по 1 апреля, информация по ней доступна на сайте www.winwriters.com. Вернемся к MadCap Flare.

Flare — программа, предназначенная для создания и организации контента, который впоследствии можно использовать и для печати, и для публикации на сайте. Я пришла к ней, потому что на сегодняшний день это единственный продукт, позволяющий относительно безболезненно взаимодействовать с Adobe FrameMaker, на котором идет весь основной поток документации в нашей компании.

Наша компания входит в состав крупной японской корпорации Topcon, подчиняясь ее американскому подразделению, которое занимается разработкой, выпуском и продажей высокоточного геодезического оборудования, а также софта, позволяющего обрабатывать результаты. Разработка и оборудования, и программного обеспечения производится в основном в России, выпуск — в Америке и Китае, продажи — по всему миру.

Соответственно, все руководства у нас выпускаются на английском языке. На текущий момент, и нет причин ожидать изменений, у нас четыре технических писателя на все московское отделение, времени ни на что кроме как на создание обычных мануалов нет, причем времени для освоения какой-либо другой программы тоже нет. Отсюда требование совместимости с Adobe FrameMaker.

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

Также хочется иметь возможность из того же текста создавать не только руководства для печати, но и онлайновый хелп.

Таким образом, мой взгляд пал на Flare, по нескольким причинам.

Во-первых, о нем очень интересно рассказывал представитель MadCap на конференции. Это действительно было одно из лучших, хорошо продуманных и подготовленных выступлений. Дескать, и функциональность богатая, и полная поддержка всякими обучающими демонстрациями и даже бесплатными интернет-семинарами по теме (к сожалению, правда, они проводятся днем по пасифик тайм — т.е. глубокой ночью по нашему времени). Надо отметить, что компания MadCap c большой любовью относится ко всем своим программам и всеми силами прививает эту любовь своим потенциальным клиентам, что, согласитесь, не может не подкупить.

Во-вторых, повторюсь, разработчиками декларируется, что Flare полностью совместим с FrameMaker, а для нас это важно.

Ну, и, в-третьих, надо же с чего-то начинать? Почему бы и не с Flare?

Начало работы

При запуске программы Flare предлагает выбор из шести вариантов.

Приветствие

Соответственно, можно начать работу с новым проектом, или импортировать уже существующий проект, или посмотреть работу программы на примере уже созданного проекта.

Выберем пункт Sample project.

Выбор учебного проекта

Экран Flare поделен на две части. Левая отведена управлению содержанием, правая — отображению содержания и работе над ним.

Сразу после запуска справа отображется стартовое окно, предлагающее на выбор: создание новых проектов, работу с уже созданными (список которых приводится здесь же), а также для желающих ссылки на средства обучения работе с Flare: на любой вкус.

Левая сторона содержит подразделы.

Первый, Project Organizer, содержит пути к управляющим файлам и их состав. Здесь создаются оглавления, здесь определяется, где что и в каком виде будет храниться, и как будет выглядеть выходной документ (на экране).

Второй — Content Explorer.

Content Explorer

Content Explorer — собственно, содержимое: файлы с текстом, иллюстрации, шаблоны страниц, и так далее. Здесь же, кстати, отобразится, если файл содержит Conditional Text: каждому созданному «кондишнл тегу» будет присваиваться свой цвет, и в этот цвет и будет раскрашиваться квадрат. Я остановлюсь на этом попозже.

Описывать подробно интерфейс Flare я не буду, остановлюсь на самых полезных с моей точки зрения функциях.

Импорт проектов

С помощью меню осуществляется импорт:

  • из FrameMaker;
  • из Microsoft Word;
  • из RoboHelp (в составе Non-Flare Project).

Меню импорта проекта

При выборе типа проекта запускается визард, помогающий определить все необходимые параметры для правильной конвертации. После чего имя импортированного проекта отображается в папке Import Project Organaizer, и, кстати, при изменении исходных файлов тот же самый проект можно импортировать заново, используя те же параметры. Выглядеть параметры импортированного файла, будут, приблизительно следущим образом.

Параметры импорта проекта

Условный текст

Следующая функция — возможность использования «кондишнл текст».

Условный текст

Для любого топика или группы или даже просто куска текста или картинки можно ставить «кондишнл тег». Вызывается всегда из меню по правой кнопке, пункт Properties. Если поставить галочку, то соответствующий квадратик в Content Explorer окрасится. Эти два тега встроены, но, разумеется, можно добавлять свои, можно переименовывать и так далее. На мой взгляд, в Flare эта функция организована гораздо более логично, чем в том же FrameMaker.

Компоновка документов

Следующая функция возможность создания различных документов из одного и того же набора исходных файлов путем создания различных структур (TOC).

Составление содержание документа

Table of Contents, содержание, может собираться из любого количества файлов в любом порядке, и таких содержаний может быть сколько угодно. В новое только что созданное содержание файлы можно «перетаскивать» из Content Explorer и расставлять по порядку и по иерархии с помощью стрелочек вверху. Если содержание сгенерировалось автоматически в процессе импорта, придется каждому элементу поставить файл в соответствие, что, впрочем, тоже никакой проблемы не оставляет — все элементы содержания, не имеющие привязанных к ним файлов, помечаются красным значком.

Свойства элемента выглядят следующим образом:

Свойства элемента

В диалоге Properties можно выбрать Link, который будет указывать на файл привязки. Кстати, выбор осуществаляется не стандартным диалогом Windows, а с помощью списка того же Content Explorer, открывающегося в новом окне. Это очень удобно. Также можно привязывать элементы оглавления не к документу, а к заголовку внутри с помощью кнопки Select Bookmark, которая отобразит списком все заголовки и все закладки в выбранном на предыдущем шаге файле, имя которого указано в поле Select Link. Обратите внимание, можно пометить вновь созданную привязку знаком New, это удобно в случае, если над одним проектом работает насколько человек и, к примеру, один из элементов оглавления изменился.

Предварительный просмотр выходных документов

Следующая функция — возможность отображения одного и того же файла в разных видах:

  • для печати;
  • в виде для публикации на сайте;
  • в виде источника XML.

Отображение для печати

Отображение для публикации на сайте

Переключение между этими двумя режимами осуществляется с помощью кнопки Layout.

Отображение в виде источника XML

В этот режим переключает кнопка <t> (она краснеет, если режим активирован). Обратите внимание: сбоку идет «подсказка» из тегов XML, где какой блок начинается и кончается, и эти блоки можно перемещать по документу, автоматически перемещая содержимое (не знаю, зачем это может понадобиться, но выглядит интересно). Если какой-либо кусок текста будет помечен «кондишнл тегом», соотвествующий блок сбоку страницы тоже подкрасится.

Целевые форматы

Возможность генерирования различных выходных файлов реализована в виде списка так называемых тагетов.

Выбор целевого формата

Это — стандартный список, он, разумеется, редактируется согласно нуждам пользователя. Свойства тагета выглядят следующим образом.

Настройка свойств выходного документа

Сборка выходного файла осуществляется с помощью команды Build, и впоследствии любой сгенерированный выходной файл доступен для просмотра с помощью команды View из меню по правой кнопке мыши. Например, если дать команду собрать PDF, получится следующее.

PDF

HTMLHelp

WebHelp

FrameMaker

Другие функции и возможности

Кому-то также может показаться интересным, что:

  • поддерживаются любые языки, в том числе, восточные и русские (кстати, интересно — русский разделен на два варианта — русский русский и молдавский русский);
  • один и тот же текст в одном и том же формате можно представлять в разном оформлении (использование функции Skin);
  • есть возможность загружать файлы из системы управления изменениями (например, Visual SourceSafe);
  • есть возможность загрузки собранного проекта на ftp-сайт или на корпоративный сайт непосредственно из Flare, для этого используется директория Destinations;
  • создание списков иллюстраций, таблиц, других элементов;
  • создание отчетов по ошибкам, например, анализ битых ссылок или случайно пропущенных и не вошедших в оглавление топиков;
  • использование единых переменных для проекта (Variables);
  • широкая поддержка графики (включая .xps, .xaml, .wmf, .emf);
  • возможность одновременного просмотра и редактирования нескольких документов.

И многое другое.

Выбор языка

Недостатки

Теперь о грустном.

Недостатки из обнаруженных:

  • Импорт из FM далеко не так идеален, как хотелось бы. Например, при импорте из FrameMaker забирается не исходная картинка, а ее изображение. Фактически, файл для импорта собирает Distiller. Я пока не нашла путь заменить все картинки на исходные оптом, а все картинки импортировать заново не хотелось бы. Также при импорте теряется форматирование страниц — я пока не нашла способа импортировать Page Layout, так что придется рисовать заново. Радует, правда, что только один раз. Показательный факт: описание процедуры оптимизации импорта проектов FrameMaker в Flare есть на сайте, и оно занимает 40 страниц.
  • Flare — XML-редактор. Обладая знаниями хотя бы основ HTML и XML, работать с документами гораздо проще. Это не было бы недостатком, если бы создатели программы не ставили в число основных достоинств своего детища то, что оно не требует знания XML для работы с ним.

Где купить, и сколько стоит

Цена MadCap Flare на данынй момент составляет 899 долларов при заказе через интернет с сайта MadCap.

Другие продукты компании MadCap

В заключение я бы хотела упомянуть некоторые другие продукты из линейки MadCap, которые могут вам пригодиться:

  • MadCap Lingо — программа, очень полезная для переводов и локализации мануалов. Содержит, например, встроенный автоматический переводчик (русско-английский словарь для которого можно бесплатно скачать на сайте MadCap).
  • MadCap Mimic — средство для создания обучающих фильмов и презентаций. В частности, если вы скачаете Trial к MadCap Flare, вы получите в комплекте шесть уроков для начинающих, созданных как раз на базе Mimic.
  • MadCap Feedback — готовое решение для организации обратной связи с вашего сайта. Например, вся активность пользователей выводится в виде статистических отчетов (ключевые слова, самые интересные темы, а также темы, котоыре никому не интересны), а также есть возможность для пользователей писать свои комментарии к темам и обращаться к разработчикам напрямую.

Ссылки

© «Философт», 2008–2017

+7 (499) 500-44-77

mail@philosoft.ru

SpyLOG