Больше, чем просто очередная среда для создания справки

Средства создания справочных материалов для программных продуктов, в основном, похожи одно на другое как капли воды. И в этом плане программа Dr.Explain, о которой я сейчас хочу вам рассказать, представляет собой приятное исключение.

Вступление: о справке в общем

В принципе, справка нужна далеко не каждому программному продукту. Есть продукты настолько простые, что пользователям просто не нужны никакие дополнительные разъяснения, как именно ими пользоваться. Но таких программ, в общем-то, немного. По мере обрастания программного продукта полезной для пользователя функциональностью возрастает и сложность его использования. И поэтому какая-никакая справочная система становится уже нужной. Для программ, разрабатываемых на заказ для каких-то организаций, создание справочной системы часто становится одним из условий успешной сдачи проекта заказчику. Почему? Потому что юзабилити этих программ находится на таком (низком) уровне, что без справки пользователь элементарно не сможет разобраться, как с этой программой работать. А работать ему с ней придётся, даже если он уже вполне привык обходиться без неё.

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

Однако справку, как ни крути, нужно в чём-то писать. Давно тому назад в "Компьютерных вестях" я рассказывал о таких китах индустрии создания справки, как RoboHelp Office (ныне он разрабатывается и продаётся уже компанией Adobe) и Help & Manual, а также о бесплатных инструментах, предоставляемых корпорацией Microsoft. Эти инструменты, конечно, весьма неплохи, но, во-первых, о них я рассказывал уже достаточно давно, а во-вторых, Dr.Explain "заточен" именно под написание справки по пользовательскому интерфейсу. И именно этим данный программный продукт, в общем-то, интересен.

Dr.Explain: знакомство

Итак, давайте приступим к знакомству с нашим сегодняшним "героем дня" в живую. Официальный сайт программы располагается по адресу www.drexplain.com. Размер дистрибутива программы составляет около 13 мегабайт.

Первое же впечатление от продукта оказывается очень даже положительным - программа сразу же предлагает посмотреть примеры проектов справочных систем, которые можно создавать с её помощью. И, надо сказать, эти проекты действительно позволяют получить практически исчерпывающее представление о её возможностях.

На первый взгляд, интерфейс программы вполне стандартен для программ этой категории: в левой части окна - дерево разделов проекта, в правой - сам редактор того, что будет отображаться в справке. Однако, если присмотреться к тому же дереву разделов, можно заметить, что не такое уж оно, на самом-то деле, и обычное. Так, например, напротив каждого элемента этого дерева можно увидеть иконку в виде замочка, с помощью которой отображается состояние раздела: или он закрыт (т.е. закончен и не нуждается в дальнейшей доработке), или ещё открыт для редактирования. И при попытке редактирования закрытых разделов программа спрашивает, действительно ли мы хотим его редактировать.

Окно редактирования справки с виду тоже обычное, впрочем, выполнено совсем не так, как в большинстве других редакторов справочной информации. Вообще говоря, типов разделов в Dr.Explain может быть всего два: первый - это тематическая страница, то есть, фактически, текстовый раздел. Второй же представляет собой скриншот с различными пояснениями к нему. Ко всему прочему, редактор разделов в Dr.Explain предлагает не просто WYSIWYG, а нечто большее: буквально одним кликом мыши вы можете посмотреть раздел именно в том виде, в котором он будет после компиляции проекта в CHM (Microsoft HTML Help) или сохранения его в виде набора HTML'ек. Удобно? Я думаю, что весьма.

Что ж, давайте поговорим подробнее именно о том, что является коньком Dr.Explain - то есть, о работе со скриншотами и пояснениями к ним. И если до этого программа казалась просто достаточно удобной, то теперь вы наверняка станете считать, что она очень удобна.

Скриншоты, скриншоты, скриншоты...

Уже при первом старте программа предлагает нам кликнуть на кнопку, которая делает снимок экрана. Только если вы открыли какой-то из предлагаемых демонстрационных проектов, вас ждёт разочарование. Программа скажет, что в испытательной версии вы не можете добавлять в проект больше пяти рисунков и создавать больше пяти разделов, а потому для детального знакомства с созданием скриншотов в Dr.Explain вам придётся начать новый проект.

Сделать можно сразу снимок всего экрана или отдельного окна на экране, указать специальные опции для создания снимков Java-приложений и отображаемых браузером HTML-страниц. В целом, настроек в окне создания скриншота столько, что они могут даже испугать неподготовленного морально пользователя. Однако после нескольких сделанных собственноручно снимков экрана можно освоиться, так что всё, в общем-то, не так уж и страшно.

Самое же интересное, пожалуй, начинается тогда, когда скриншот сделан. Вы можете добавить на него какие-нибудь поясняющие надписи, а кроме этого, сделать ещё поясняющие выноски. То есть, вы добавляете на свой скриншот такую стрелку, у которой один конец заканчивается кружком с цифрой. Для каждой из таких стрелок можно добавить надпись, которая будет служить кратком пояснением к тому или иному элементу окна. Кроме того, можно ещё добавить и более подробное пояснение. Для всех выносок программа автоматически сгенерирует приятную на вид табличку, которая будет размещаться ниже изображения окна с выносками и которая как раз и будет включать в себя все эти подробные пояснения. Посмотреть, как именно эта табличка будет выглядеть, можно с помощью вкладок предварительного просмотра HTML Preview и CHM Page Preview, о которых я уже упоминал выше.

Что ещё осталось за кадром

Что ж, такая всесторонняя поддержка работы со скриншотами, равно как и тщательно проработанный и оптимизированный именно под неё пользовательский интерфейс, - это, безусловно, просто замечательно. Однако давайте посмотрим на те возможности Dr.Explain, которые пока что остались за кадром.

Для начала стоит сказать несколько слов о создаваемых программой проектах справки. Они сохраняются целиком в одном файле, что, на мой взгляд, удобнее создаваемых тем же RoboHelp'ом множеств файлов, где каждая картинка, каждый скрипт и каждая другая мелкая деталь лежит отдельно. Кстати, если взглянуть на файлы, создаваемые этой программой, внимательнее, то можно обнаружить, что это на самом деле XML-документы.

Что можно назвать однозначным минусом Dr.Explain, так это поддержку WinHelp. Вернее, её полное отсутствие. Конечно, сегодня сложно рекомендовать кому-то пользоваться WinHelp'ом из соображений совместимости, но я лично знаю немало пользователей, которые предпочитают именно этот формат в силу своего консерватизма. Для таких пользователей в своё время многие рекомендовали делать в программе справку сразу в двух форматах - и в HTML Help, и в WinHelp. В принципе, нельзя сказать, чтобы это было так уж критично, и что поддержка WinHelp'а была так уж критически важна - но ведь нужно сказать про этот замечательный программный продукт хоть что-нибудь плохое, верно?

Из интересных инструментов, предлагаемых пользователям программы, стоит ещё упомянуть мастер валидации проектов и инструмент приведения их в более компактный вид путём удаления всякого более не используемого мусора. Правда, в незарегистрированной версии оба инструмента наотрез отказываются работать.

Подведём итоги

Что ж, давайте подытожим всё, что было сказано выше. Думаю, из моего рассказа вам стало вполне ясно, что Dr.Explain - замечательная программа, предельно удобная для тех, кто пишет справку для продуктов класса end-user. Конечно, если вы пишете масштабную справку для не менее масштабного проекта, то вас наверняка больше заинтересует тот же RoboHelp, а если справку для какого-нибудь девелоперского продукта, то вам больше подойдут продукты, которые умеют парсить код на том языке программирования, на котором эти библиотеки или компоненты написаны. Но если вам нужно делать справку, основанную, фактически, на пояснениях к скриншотам, то Dr.Explain будет просто замечательным выбором. Конечно, программа эта не бесплатная, но если подумать, то она здорово экономит время и улучшает внешний вид и удобство справки, что, согласитесь, весьма немаловажно.

Вадим СТАНКЕВИЧ,
dreamdrusch@tut.by