Help authoring tool

Software to aid production of "help" systems

For other uses, see Hat (disambiguation).

This article needs additional citations for verification. Please help improve this article by adding citations to reliable sources. Unsourced material may be challenged and removed.
Find sources: "Help authoring tool" – news · newspapers · books · scholar · JSTOR (October 2024) (Learn how and when to remove this message)

|

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

## 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:

* Automatic or assisted Index generation
* Automatic Table of Contents
* Spelling checker
* Image editing
* Image hotspot editing
* Import and export of text in XML files, for exchange with computer-assisted translation programs

## Common help authoring tools

[edit]

Some common HATs include:

* HelpNDoc
* Adobe RoboHelp
* HelpSmith
* Doc-To-Help
* MadCap Flare
* Help & Manual
* Sandcastle
* AsciiDoc

## Related software

[edit]

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

## See also

[edit]

* List of help authoring tools
* User assistance

Authority control databases

National|

* Germany
* United States
* Israel

Other|

* Yale LUX

## References

[edit]

1. ^ Heath, Catherine (2019-01-14). "Best Help Authoring Tools (HAT) & Software Compared for 2024". Document360. Retrieved 2024-09-12.
2. ^ "What is an help authoring tool ?". www.helpndoc.com. Retrieved 2024-09-12.