Puneet Varma (Editor)

Help authoring tool

Updated on
Edit
Like
Comment
Share on FacebookTweet on TwitterShare on LinkedInShare on Reddit

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

Contents

Functions

The basic functions of Help Authoring Tools 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, though they can include such formats as ASCII, HTML, OpenOffice Writer and Microsoft Word, and compiled Help formats such as Microsoft WinHelp and Microsoft Compressed 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

    Some common HATs include:

  • HelpNDoc
  • Adobe RoboHelp
  • Doc-To-Help
  • MadCap Flare
  • HelpConsole
  • Help & Manual
  • WebWorks ePublisher
  • Help Generator
  • ProProfs
  • HelpSmith
  • Sandcastle
  • AsciiDoc

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

    References

    Help authoring tool Wikipedia
    (Text) CC BY-SA