Help authoring tool
From Wikipedia, the free encyclopedia
A help-authoring tool or HAT is a software program used by technical writers to create online help manuals.
Contents |
[edit] Functions
The basic functions of help-authoring tools can be divided into the following categories:
[edit] 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.
[edit] 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.
[edit] 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
[edit] 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.
- HyperText Studio: WYSIWYG Help authoring tool for creating WinHelp, HTML Help, Browser based help and print documents.
- 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.
- PaperKiller: Visual WYSIWYG Help authoring tool for creating WinHelp, HTML Help and CD/DVD based help and manuals
- RoboHelp: A specialized tool for creating online help.
- HelpMaker Free WYSIWIG help authoring tool the outputs in WinHelp, HTML Help, PDF and other formats.
See MSHelpWiki for a list of all available Help authoring tools for the Windows platform.
See HAT-Matrix for an interactive comparison of the most popular Help authoring tools.
[edit] Related software
Technical writers often use content management systems and version control systems to manage their work.
