Surf Wiki
Save to docs
general/technical-communication

From Surf Wiki (app.surf) — the open knowledge base

Help authoring tool

Software to aid production of "help" systems

Software to aid production of "help" systems

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

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:

  • 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

References

References

  1. Heath, Catherine. (2019-01-14). "Best Help Authoring Tools (HAT) & Software Compared for 2024".
  2. "What is an help authoring tool ?".
Info: Wikipedia Source

This article was imported from Wikipedia and is available under the Creative Commons Attribution-ShareAlike 4.0 License. Content has been adapted to SurfDoc format. Original contributors can be found on the article history page.

technical-communication technical-communication-tools help-authoring-tools
Want to explore this topic further?

Ask Mako anything about Help authoring tool — get instant answers, deeper analysis, and related topics.

Research with Mako

Free with your Surf account

Content sourced from Wikipedia, available under CC BY-SA 4.0.

This content may have been generated or modified by AI. CloudSurf Software LLC is not responsible for the accuracy, completeness, or reliability of AI-generated content. Always verify important information from primary sources.

Report