A help-authoring tool or HAT is a software program used by technical writers to create online help manuals.
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 using a text editor. File formats that can be imported include ASCII, HTML and Microsoft Word, and compiled help formats such as Microsoft WinHelp and Microsoft Compressed HTML Help. The ability to import compiled help formats is useful when the source text for those files has been lost.
Help output
The output from a HAT can be either a specialised help file in a format such as WinHelp or Microsoft Compiled HTML, or a general-purpose document file such as Adobe PDF or HTML.
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 help authoring tools include:
- Adobe FrameMaker: The most common tool for large technical documents. Requires other tools to convert content to online Help.
- AuthorIT: A collaborative authoring tool used for single-source content management.
- Chm maker: An easy-to-use help authoring tool for creating help files in CHM format.
- Doc-To-Help: An authoring tool that creates various online Help formats and printed manuals from Microsoft Word or HTML source documents.
- Epic Editor: An XML-based authoring tool.
- Help & Manual from EC Software: Creates online help in WinHelp, HTML Help, PDF and other formats.
- HelpServer: A web-based and server-based authoring tool to organize help and documentation portals throughout an enterprise.
- HTML Help Generator: Help generator and authoring tool for Visual Basic, Microsoft Access and Visual Studio .NET.
- HyperText Studio: WYSIWYG Help authoring tool for creating WinHelp, HTML Help, Browser based help and print documents.
- MadCap Flare Technical Writing Tips for Flare
- Microsoft HTML Help SDK: A collection of tools for creating files in Microsoft's HTML Help format.
- Microsoft Word: Widely used for technical writing despite its limitations. Requires other tools to convert content to online Help.
- Microsoft Visio: Software for creating diagrams.
- Mif2Go: Publishes Frame documents to online Help format.
- QuickHelp: Platform neutral help authoring format for Windows, Macintosh and Linux with conditional topics
- Republicorp XDK: An XML, HTML, and Help toolkit based on Microsoft Word.
- RoboHelp: A specialized tool for creating online help.
- Webworks Publisher: Converts documents in various formats to other formats, primarily HTML. Requires Adobe FrameMaker or Microsoft Word.
- WinCHM: An easy-to-use HTML help authoring tool.
- XMetaL Author DITA Edition: An XML editor optimized for single-source output (including online help) based on the DITA standard.
- digipedia from the makers of Sevensteps.
See MSHelpWiki for a list of all available Help authoring tools.
Related software
Technical writers often use content management systems and version control systems to manage their work.