Jump to content

Help authoring tool

From Wikipedia, the free encyclopedia

A Help Authoring Tool or HAT is a software program used by technical writers to create online help systems.

Functions

[edit]

The basic functions of a Help Authoring Tool (HAT) can be divided into the following categories:

File input

[edit]

HATs obtain their source text either by importing it from a file produced by another program, or by allowing the author to create the text within the tool by using an editor. File formats that can be imported vary from HAT to HAT. Acceptable file formats can include ASCII, HTML, OpenOffice Writer and Microsoft Word, and compiled Help formats such as Microsoft WinHelp and Microsoft Compiled HTML Help.

Help output

[edit]

The output from a HAT can be either a compiled Help file in a format such as WinHelp (*.HLP) or Microsoft Compiled HTML Help (*.CHM), or noncompiled file formats such as Adobe PDF, XML, HTML or JavaHelp.

Auxiliary functions

[edit]

Some HATs provide extra functions such as:

Common help authoring tools

[edit]

Some common HATs include:

[edit]

Technical writers often use content management systems and version control systems to manage their work.

See also

[edit]