# Help authoring tool

> Mediated Wiki article. Canonical URL: https://mediated.wiki/source/Help_authoring_tool
> Markdown URL: https://mediated.wiki/source/Help_authoring_tool.md
> Source: https://en.wikipedia.org/wiki/Help_authoring_tool
> Source revision: 1351926983
> License: Creative Commons Attribution-ShareAlike 4.0 International (https://creativecommons.org/licenses/by-sa/4.0/)

Software to aid production of "help" systems

For other uses, see [Hat (disambiguation)](/source/Hat_(disambiguation)).

This article needs more citations. 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](/source/Technical_writer) to create [online help](/source/Online_help) systems.[1][2]

## 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](/source/ASCII), [HTML](/source/HTML), [OpenOffice Writer](/source/OpenOffice.org) and [Microsoft Word](/source/Microsoft_Word), and compiled Help formats such as [Microsoft WinHelp](/source/Microsoft_WinHelp) and [Microsoft Compiled HTML Help](/source/Microsoft_Compiled_HTML_Help).

### Help output

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

### Auxiliary functions

Some HATs provide extra functions such as:

- Automatic or assisted [Index](/source/Index_(publishing)) generation

- Automatic [Table of Contents](/source/Table_of_Contents)

- [Spelling checker](/source/Spelling_checker)

- Image editing

- Image hotspot editing

- Import and export of text in [XML](/source/XML) files, for exchange with [computer-assisted translation](/source/Computer-assisted_translation) programs

## Common help authoring tools

Some common HATs include:

- [HelpNDoc](/source/HelpNDoc)

- [Adobe RoboHelp](/source/Adobe_RoboHelp)

- [HelpSmith](/source/HelpSmith)

- Doc-To-Help

- MadCap Flare

- Help & Manual

- [Sandcastle](/source/Sandcastle_(software))

- [AsciiDoc](/source/AsciiDoc)

## Related software

Technical writers often use [content management systems](/source/Content_management_system) and [version control systems](/source/Version_control_system) to manage their work.

## See also

- [List of help authoring tools](/source/List_of_help_authoring_tools)

- [User assistance](/source/User_assistance)

Authority control databases International GND National United States Israel Other Yale LUX

## References

1. **[^](#cite_ref-1)** Heath, Catherine (2019-01-14). ["Best Help Authoring Tools (HAT) & Software Compared for 2024"](https://document360.com/blog/help-authoring-tools/). *Document360*. Retrieved 2024-09-12.

1. **[^](#cite_ref-2)** ["What is an help authoring tool ?"](https://www.helpndoc.com/help-authoring-tool/). *www.helpndoc.com*. Retrieved 2024-09-12.

---
Adapted from the Wikipedia article [Help authoring tool](https://en.wikipedia.org/wiki/Help_authoring_tool) by Wikipedia contributors ([contributor history](https://en.wikipedia.org/wiki/Help_authoring_tool?action=history)). Available under [Creative Commons Attribution-ShareAlike 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/). Changes may have been made.