Help&Manual

О программе

Help&Manual - удобнейшее приложение для работы с документацией – для ее создания, оформления и публикации в самые разные форматы: CHM, WebHelp, PDF, DOCX, EPUB, MOBI и др. По сути это программный комплекс, потому что кроме непосредственно редактора структуры и контента в него входит графический редактор для создания иллюстраций, редактор шаблонов для наведения красоты в PDF и видеограббер для снятия видео с экрана и вставки его в документацию.

Быстрый старт

Структура

Чтобы начать новый проект надо кликнуть на кнопку и выбрать, как вы хотите проект создавать - или с "чистого листа", или импортировать из другого формата. Даже если вы выберите чистый проект, то после его создания в левом блоке Project Explorer образуется начальная структура проекта с парой разделов верхнего уровня и несколькими разделами дочерних уровней. Вам теперь предстоит эти раздела переименовать и заполнить свои контентом.

В Project Explorer может быть открыто несколько проектов, которые могут сворачиваться/разворачиваться по клику на их название. В каждом проекте есть Содержание (Table of Contents), Файлы (Projects Files) и Настройки (Configurations).

Projects Files создаются автоматически по мере создания вами новых разделов. Каждый раздел - это новый xml-файл внутри проекта, а при публикации, например, в WebHelp - это новый html-файл на диске. Раздел в проекте имеет свой термин - Topic. Обязательно присваивайте ID каждому топику - это будет имя файла, и по ID можно будет ссылаться на этот топик из других топиков. ID можно задать в окне Topic Options (см. закладку между Project Explorer и самим топиком).

В Configurations регулируются настройки как проекта в целом, так и параметры публикации для каждого формата.

Все инструменты для манипуляций с Project Explorer расположены на панели верхнего меню Projects. Создавать новые топики, менять их взаимное расположение и иерархию, менять иконки...

Редактирование

При клике на топик в Table of Contents открывается соответствующая топику страница в главном окне. Переключите верхнее меню на закладку Write, которая по своему составу напомнит вам MS Word. Тут вам и карты в руки.

Замечу, что кроме WISIWYG представления в редакторе есть еще XML представление (см. закладку между Project Explorer и самим топиком). Если вы разбираетесь в тэгах HTML и свойствах CSS, то тут можете применить свои знания.

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

Публикация

Уважаемой особенностью программ для создания документации является их способность публиковать проект в самые разнообразные форматы. Но мне лично достаточно двух из представленных восьми в Help+Manual. Это PDF, пожалуй самый универсальный формат, доступный для просмотра практически на любом устройстве. И формат WebHelp - очень выигрышный формат справки для просмотра из любого браузера. Ну, может быть еще EPUB для любителей читать книги на мобильном устройстве. Эти три формата перекрывают 100% потенциальных читателей.

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

Публикация результата вашего труда начинается с кнопки - после нажатия на нее выбирается формат вывода и нажимается кнопка [Publish Now!]. Посмотрите как это выглядит и, возможно, у вас появится желание кастомизировать форматирование html-страниц. Не обязательно этим заниматься с набором html-файлов, которые вы получили на диске. Это можно сделать в Project Explorer > Configurations > Publishing Options > WebHelp, чтобы закрепить свое форматирование для всех последующих публикаций.

Скачать