Инструмент для создания справок

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

Функции

Основные функции инструмента разработки справки (HAT) можно разделить на следующие категории:

Ввод файла

HAT получают исходный текст либо путем импорта его из файла, созданного другой программой, либо путем разрешения автору создать текст в инструменте с помощью редактора. Форматы файлов, которые можно импортировать, варьируются от HAT до HAT. Допустимые форматы файлов включают ASCII , HTML , OpenOffice Writer и Microsoft Word , а также форматы скомпилированной справки, такие как Microsoft WinHelp и Microsoft Compiled HTML Help .

Вывод справки

Выходными данными HAT может быть либо скомпилированный файл справки в таком формате, как WinHelp (*.HLP) или Microsoft Compiled HTML Help (*.CHM), либо некомпилированные форматы файлов, такие как Adobe PDF , XML , HTML или JavaHelp .

Вспомогательные функции

Некоторые HAT предоставляют дополнительные функции, такие как:

Автоматическое или вспомогательное индекса создание
Автоматическое оглавление
Проверка орфографии
Редактирование изображений
Редактирование горячих точек изображения
Импорт и экспорт текста в файлах XML для обмена с компьютерного перевода. программами

Общие инструменты создания справки

Некоторые распространенные HAT включают в себя:

Сопутствующее программное обеспечение

Технические писатели часто используют системы управления контентом и системы контроля версий для управления своей работой.

См. также