«Документальный» плюс

Денис Колисниченко

Спецвыпуск: Хакер, номер #053, стр. 053-048-7

Обычно Help Workshop неправильно устанавливает начальную страницу (Default Topic). Эта страница будет отображена при запуске справочной системы первой. Нажми кнопку Change project options (самая верхняя кнопка на странице Project) и в появившемся окне введи заголовок проекта и выбери файл по умолчанию (Default file) из списка. Файл должен быть указан в списке FILES.

Закладка Contents используется для создания нового файла содержания, который содержит информацию о разделах справочной системы. Закладка Index позволяет создать файл указателя – не ленись! Разобраться с этими закладками особого труда для тебя не составит, поэтому комментировать их не буду.

Когда файл проекта будет готов к компиляции, нажми кнопку Compile HTML file, которая находится на панели инструментов Help WorkShop, или выбери команду File, Compile. Убедительно рекомендую перед компилированием сохранить файл проекта. После завершения процесса компилирования увидишь протокол компилирования, в котором Help WorkShop предоставит подробный отчет о разделах, файлах, картинках, ошибках и предупреждениях.

Вот, собственно, и все. Помни: конечный пользователь не хочет много думать, он хочет получить простой, понятный и наглядный продукт. Документация - неотъемлемая часть хорошей программы.