Обзор программ

HelpScribble.
Программа HelpScribble создана компанией  JGSoft. Оценочную версию
программы можно загрузить с веб-сайта компании (www.helpscribble.com).
Она имеет некоторые функциональные ограничения, в частности, в каждый
раздел справочника помещается уведомление о том, что он создан с
использованием trial-версии программы. 
Программа HelpScribble в определенной степени поддерживает
технологию единственного источника: она позволяет получать справочную
систему в форматах WinHelp и HTML Help, а также выполнять экспорт
содержимого справочника в RTF- и/или HTML-файлы. Тем не менее в
основном программа HelpScribble ориентирована на подготовку справочника
WinHelp.
Для генерации HLP- и CHM-файлов HelpScribble использует
соответствующие компиляторы от Microsoft, которые разработчик
справочника должен предварительно установить на свой компьютер
самостоятельно. Поскольку при попытке первой компиляции справочника
HelpScribble начинает сканировать все жесткие диски компьютера в поисках
компилятора. Поэтому надо сначала указать пути до компилятора:
(Options/Compilator). 
Достоинством HelpScribble можно считать наличие развитых средств
редактирования текста в формате RTF. При этом авторское решение по
визуальному представлению редактируемого текста достаточно оригинально:
элементы разметки, относящиеся к основному RTF-формату, остаются
скрытыми, а элементы разметки, относящиеся к подмножеству Help RTF,
отображаются на экране.
 Help And Manual.
Оценочная версия программы находится на сайте разработчика, компании
EC Software, по адресу www.helpandmanual.com. Оценочная версия
работоспособна в течении 14 дней. Имеется ещё одно ограничение: при
генерации справочника в формате HTML Help некоторые гипертекстовые
ссылки заменяются ссылками на сайт разработчика.
С помощью этого пакета можно получить справочник в трех форматах:
WinHelp, HTML Help и WebHelp (разработчики HelpAnd Manual именуют его
Brouser Based Help). Кроме того, возможен экспорт справочника в PDF-файл
и в файл формата текстового редактора Word (.doc или .rtf).
Пакет HelpAnd Manual использует для генерации справочников в
форматах WinHelp и HTML Help компиляторы от Microsoft, однако прямого
доступа к интерфейсу Help Workshop и HTML Help Workshop разработчик
справочника не имеет.
Пакет HelpAnd Manual способен декомпилировать справочные файлы
(.hlp и .chm) и создать на их основе новый проект.
При создании русскоязычного справочника в формате WinHelp никаких
дополнительных настроек выполнять не требуется. Перед генерацией CHM-
файла необходимо указать используемый язык. Также, на сайте компании
можно получить русский словарь, подключаемый к Help And Manual для
проверки правописания текста разделов.
 Создание справочника
В итоге выбор пал на программу Dr.Explain поскольку она подошла
оптимально для поставленной задачи.
Во-первых программа имеет интуитивно понятный, русскоязычный
интерфейс в отличии от конкурентов.
Во-вторых хоть и функционал пробной версии ограничен, но в тоже
время достаточен.
В-третьих нет ни каких проблем при компиляции русско-язычного
шрифта. 
Рассмотрим программу подробнее.
Чтобы создать новый проект, нужно сделать следующее:
 использовать стартовый диалог;
 щёлкнуть по кнопке  ;
 перейти в меню Файл и щёлкнуть по команде Создать;

Оглавление представляет собой список частей (тем) документа или

файла помощи, организованных в порядке их следования. Темы могут
относиться к нескольким уровням. Например, тема A является темой первого
уровня и включает в себя несколько тем второго уровня (A1, A2, A3 и т.д), а
тема A1 второго уровня может иметь собственную подтему, которая
структурно будет являться темой третьего уровня (A1A):
 

Тема является аналогом отдельного документа, над которым вы

работаете. Dr.Explain управляет оглавлением и составляющими его темами
как единым документом (проектным файлом).
Можно раскрывать и сворачивать темы в оглавлении, используя
стандартные контролы, либо перемещать темы и менять их уровень в
иерархическом дереве оглавления.
 
 Создание или добавление тем является наиболее частым действием при
работе с оглавлением. Оно похоже на создание новых документов в обычных
текстовых редакторах. После создания темы вы можете начать добавлять в
неё текст и прочие материалы, а также перемещать её в пределах оглавления.
Чтобы добавить новую тему на текущем уровне, наведите курсор на
тему более высокого уровня и выберите её. Если вы выберете произвольную
тему и создадите новую, то она будет создана как подтема выбранной темы.
 
Существует несколько способов добавления темы в оглавление:
 щёлкнуть по кнопке 
 перейти в меню Настройки и выбрать пункт Добавить тему
Ctrl+T;
 использовать сочетание клавиш Ctrl+T;
 щелкнуть по нужной теме правой кнопкой и выбрать Добавить...,
затем Добавить тему Ctrl+T;
 импортировать данные из других файлов при помощи диалога
импорта.

Возможны три варианта добавления новой темы:

 тема с текстом;
 тема с аннотацией и скриншотом;
 тема с картинкой из файла.

При добавлении темы программа попросит указать её имя в

оглавлении. Это имя можно поменять позже в любой момент, щёлкнув по
нему и удерживая его в течение нескольких секунд. После смены имени
нажмите Ввод или просто переключитесь на другую тему.
При добавлении тем в ваш проект нужно организовывать их таким образом,
чтобы оглавление отражало структуру вашей будущей документации.
 
Существует несколько способов задания положения тем внутри оглавления:
 щёлкните правой кнопкой мыши по теме, которую желаете
переместить, и выберите нужный пункт меню: Выше или Ниже
 используйте комбинации клавиш Ctrl+Up и Ctrl+Down
 перетягивайте темы внутри дерева оглавления мышью
 используйте стандартные команды операционной
системы: Копировать, Вырезать и Вставить

Чтобы заблокировать тему, щёлкните по ней правой кнопкой мыши и

выберите команду Заблокировать. Этот же раздел меню позволяет также
заблокировать тему и её потомков.

 
Чтобы разблокировать тему, щёлкните по ней правой кнопкой мыши и
выберите команду Разблокировать текущий и потомков.
  Тексты в Dr.Explain можно редактировать так же, как вы делаете это в
любом текстовом редакторе. Вы можете либо редактировать их вручную,
либо настроить стили для вашего проекта.
 
Стили позволяют вам задавать глобальные настройки текста, которые будут
использоваться во всём проекте. После изменения любого стиля Dr.Explain
автоматически обновит текст во всех темах.
 
Редактор контента Dr.Explain позволяет редактировать темы в режиме
WYSIWYG, включая растровые изображения,
тексты, ссылки, аннотированные скриншоты, названия, таблицы и прочие
объекты, которые можно добавить при помощи текстового редактора.
 

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

Программа Dr.Explain крайне удобна для разработки справочной

документации со множеством скриншотов и технических иллюстраций.
Встроенный инструмент захвата экрана анализирует структуру
захваченных изображений или онлайн-форм и автоматически создаёт
нумерованные аннотации ко всем значимым элементам интерфейса: кнопкам,
полям, опциям, меню, панелям инструментов и так далее. Вам остаётся лишь
добавить их описания для завершения аннотирования.
Скриншотом называется захваченное изображение экрана без каких бы то ни
было аннотаций или выносок, в то время как аннотированный скриншот
позволяет вам настраивать внешний вид захваченных экранов, выносок и
надписей.
Dr.Explain позволяет вам вставлять изображения из файлов,
сохранённых на вашем компьютере, или захватывать новые изображения с
экрана. Вставка изображений удобна в ситуациях, когда у вас нет доступа к
приложению, работу которого вы документируете. Вы можете вставить
изображение из сделанных ранее скриншотов или вручную добавить
аннотации. Вы также всегда можете использовать встроенный инструмент
захвата экрана, чтобы создать скриншот и вставить его в вашу тему.
 
Программа поддерживает следующие форматы:
  BMP
 JPG
 GIF
 PNG

Для вставки изображения из файла существует два сценария:

 если вы хотите добавить изображение из файла в вашу тему,
щёлкните по кнопке  ;
 если вы хотите добавить новую тему (окно) из файла, перейдите в
раздел Настройки или щёлкните кнопку   со стрелкой, а затем
выберите команду Добавить тему с экраном из файла.

Если воспользоваться вторым вариантом, его нужно будет вручную

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