Help authoring tool

{{Short description|Software to aid production of "help" systems}}

{{Other uses|Hat (disambiguation)}}

{{More citations needed|date=October 2024}}

A Help Authoring Tool or HAT is a software program used by technical writers to create online help systems.{{Cite web |last=Heath |first=Catherine |date=2019-01-14 |title=Best Help Authoring Tools (HAT) & Software Compared for 2024 |url=https://document360.com/blog/help-authoring-tools/ |access-date=2024-09-12 |website=Document360 |language=en-US}}{{Cite web |title=What is an help authoring tool ? |url=https://www.helpndoc.com/help-authoring-tool/ |access-date=2024-09-12 |website=www.helpndoc.com |language=en}}

Functions

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

=File input=

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=

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=

Some HATs provide extra functions such as:

Common help authoring tools

Related software

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

See also

References