Реклама в журнале

Тяжкий писательский труд

Источник: http://www.softkey.info/

Блаженные верующие, что считают законченной свою работу над программой после того, как создан исполняемый модуль, и компилятор отложен в долгий ящик. Ибо именно в этот момент наступает время прозрения, и начинается тяжкий труд по документированию всех возможностей созданного чуда программной мысли. А если ваша программа должна поставляться еще и с поддержкой нескольких форматов описания, то проблемы тихо перерастают в кризис времени, нервов и гонки на выживание. А раз так, то возьмем на вооружение следующие правила: "Экономьте деньги, экономьте время, сконцентрируйтесь на содержимом и получайте удовольствие от процесса создания систем помощи пользователям"... Как, вы еще не догадались? Так это же Help&Manual собственной персоной!

Что такое Help&Manual? Это система для быстрого и наглядного создания файлов помощи и электронных документов - в первую очередь для Windows. При этом программа ориентирована на различные группы, начиная от обычных пользователей, волей судьбы вынужденных создавать электронные документы, и заканчивая профессиональными программистами, создающими файлы помощи для разрабатываемых продуктов. Инсталляционный пакет Help&Manual занимает 12 мегабайт; кроме того, для полноценной работы желательно поставить на машину MS HtmlHelp (3.5 мегабайта) и HtmlHelp Workshop (1.6 мегабайта), после чего ваше рабочее место писателя можно считать полностью оборудованным. Установка программы не вызывает каких-либо затруднений, все шаги подробно документированы и логичны. Кроме того, для вашего удобства предлагается поставить примеры, изучая которые, можно в дальнейшем быстрее освоить продукт (11 мегабайт примеров из 30 мегабайт, занятых в итоге).

Help&Manual (последняя версия 3.25) помогает вам удобно и с минимальными затратами создать шаблон системы помощи для пользователя, после чего на его основе можно сгенерировать итоговый документ в следующих форматах:

  • WinHelp 2 (MS Help 2);
  • HTML Help;
  • Classic Windows Help;
  • HTML (classic help documentation);
  • Adobe PDF;
  • MS Word (RTF format);
  • MMHelp.

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

  • создание нескольких основных разделов и подразделов;
  • наполнение каждого из разделов статьями, описывающими те или иные особенности выбранной темы;
  • формирование заголовков статей, по которым можно будет быстро найти необходимый материал и собираемых затем в таблицу тем, доступных для поиска;
  • описание ключевых слов, по которым можно произвести быстрый поиск в итоговом документе данной статьи;
  • создание списка ассоциативных ключей, по которым будет формироваться ссылка "смотрите также".

Такой порядок работы используется еще со времен создания первых файлов помощи для MS Windows. Кстати, многие системы визуальной разработки электронных документов используют данную последовательность.

С каких шагов оптимальнее всего начинать создание нового документа? Перво-наперво, желательно сформировать дерево будущих разделов - это позволит упорядочить в дальнейшем размещение отобранного для публикации материала. После того как мы построили дерево статей, можно переходить к их непосредственному наполнению текстом. Длительный опыт создания файлов помощи для разрабатываемых продуктов и разнообразных корпоративных материалов позволяет рекомендовать следующую последовательность получения итогового документа:

  • Не торопитесь начинать решать технические проблемы с расстановкой ссылок и оформлением стилей выводимого текста, набейте сначала саму публикуемую информацию.
  • Текст можно набирать как в самом Help&Manual, так и других офисных системах - где вам будет удобнее. Часто документацию поставляют в двух комплектах: урезанный вариант в форматах MS Word и подобных ему, а более полную и технически дополненную - в виде файлов помощи. Фактически, первоначальный "укороченный" текст просто перекочевывает частично или полностью в те или иные разделы файлов помощи.
  • Унифицируйте внешний вид изображений, которые будут сопровождать описание. Сходные по размерам и внешнему виду картинки качественно отличают прилично выполненные документы от слепленных "на коленке" самоделок.
  • Выработайте один и тот же стиль для оформления документа и придерживайтесь его для всех статей в создаваемом продукте.
  • Оптимальнее всего "причесать" созданный документ в самом конце работы, расставив при этом необходимые ключевые слова, корректные ссылки (на все уже занесенные статьи), проверив однотипность публикуемого материала на всех страницах. 

Теперь давайте рассмотрим, как нам может помочь в этой работе Help&Manual.

Первым делом мы заполним дерево навигации по документу, используя для этого панель Table of Contents. Обычно она расположена в левой части рабочего окна программы, при этом ее можно оттуда "отцепить" и перетащить в более удобное место. Двойной щелчок на заголовке этого плавающего окна вернет панель обратно. Попутно стоит заметить, что любые панели с кнопками управления программой можно также передвигать по экрану и размещать где угодно. В заполняемом дереве заголовков можно добавлять, удалять элементы, редактировать их описание и передвигать их по всему дереву с места на место (включая и все подразделы, расположенные ниже). За все возможные варианты управления разделами отвечает раздел Topics в меню. Кроме описанного редактирования, сюда входит еще управление "развертыванием/свертыванием" всех веток для просмотра, запись содержимого раздела в виде файла или загрузка информации с диска.

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

  • стандартное редактирование (выделение, копирование, перенос, удаление);
  • дополнительное оформление текста (изменение размера и вида шрифтов, цвета выводимого текста;
  • форматирование внешнего вида параграфов, установка отступов и расположения на странице (справа, слева, по центру);
  • настройка перечисляемых разделов (с нумерацией разделов или визуальным оформлением в виде графических маркеров).

Кроме того, набираемый текст можно форматировать согласно уже заложенным шаблонам (оформить как заголовок, как обычный текст, согласно заложенным заранее настройкам). Стили оформления (шаблоны) можно добавлять и редактировать в настройках программы. Весьма удобна возможность использования "горячих клавиш" для их быстрого вызова.

Далее, мы можем дополнить полученный текст дополнительными элементами оформления:

  • изображениями (поддерживается два популярных для MS Windows формата: BMP, Windows Metafile);
  • AVI-файлами;
  • OLE-объектами (не забудьте убедиться, что для его показа данный объект будет установлен у клиента на машине);
  • символами из шрифтов (греческий, латинский и т.д.);
  • горизонтальными линиями, разделителями страницы;
  • HTML-кодом.

Для тех, кому приходится разрабатывать сложные тексты, будет удобна возможность использования специальных инструментов:

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

В завершение рассказа о редактировании текста отметим возможность вставки в материал таблиц. Поддерживается размещение таблицы на странице, изменение ее положения, объединение части колонок в одно целое, разделение таблицы на несколько частей.

Следующим шагом после размещения содержимого документов является приведение к стандартам внешнего вида. Использование корпоративных стандартов по стилям документов и уже описанных выше шаблонов Help&Manual (Style Sheet) позволит быстро оформить итоговый документ.

Завершающим этапом работ является создание внутренних связей в документе и описание ключевых слов для последующего поиска в массиве информации. Для удобства навигации по уже заложенным в документ ссылкам лучше всего использовать Topic Referrer Report (вызывается из меню Topic / Find Referrers). Вторым мощным инструментом является Project Report (Tools / Report). Вы можете выбрать описание статей по различным маскам (включая показ модифицированных разделов в тот или иной промежуток времени), задать детализацию отчета, а также всегда иметь перед глазами статистику возможных проблем в создаваемом документе (нарушение связей, потерянные статьи и так далее).

Из дополнительных инструментов, включенных в Help&Manual, хочется отдельно отметить Screen Capture - средство для "моментальных снимков" внешнего вида программ. Вызов данного инструмента позволит вам получить в одно нажатие клавиши мыши готовую иллюстрацию к разрабатываемому документу. Screen Capture радует обилием настроек, которые включают в себя масштабирование итогового изображения, задание характеристик захватываемых объектов (отдельная программа, часть десктопа, фиксированные области экрана), внешнее оформление итоговой картинки, включая разнообразные характеристики теней и задание "источника подсветки" с указанием его направления. Если вы не собираетесь дополнительно дорабатывать спецэффекты в Adobe Photoshop и ему подобных, то данного инструмента будет более чем достаточно для получения необходимых иллюстраций. 

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

  • Common Properties объединяет в себе заголовок и копирайты, настройку языка отображения документа, шрифты, поддержку генерации констант для последующего использования в программных проектах (С++, Delphi и так далее), пути к графическим иллюстрациям данного документа, настройку текстовых переменных (для использования в статьях в макроподстановках);
  • Style Sheets описывает все доступные в документы стили (шрифт, характеристики параграфа, горячие клавиши);
  • детальные настройки каждого из форматов для генерации (а это WinHelp, HTML Help, HTML Export, Adobe PDF, MS Word RTF, e-Book).

Кроме того, настройки самого Help&Manual вынесены в отдельный блок (Tools / Customize). Используя их, вы можете задавать внешний вид программы, генерацию части кода по умолчанию, пути по умолчанию для проектов и временных файлов, доступ к внешним компиляторам файлов помощи и многое другое.

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

Ссылки по теме:

Автор статьи: Олег Борисов




Играйте и выигрывайте! Интернет лотерея iLoto.net
Реклама в журнале

Copyright © <LMTH>. Все материалы являются собственностью их авторов.
При перепечатывании ссылка на http://www.magaz.org/ как на источник
информации обязательна. Правила использования материалов журнала