Help authoring tool: Difference between revisions

Revision as of 15:17, 1 December 2004

Latest revision as of 11:24, 4 July 2025

(255 intermediate revisions by more than 100 users not shown)

Line 1:

{{Short description|Software to aid production of "help" systems}}

A '''Help authoring tool''' or '''HAT''' is a software program used by [[Technical writer|technical writers]] to create online [[Help (online)|Help]].

{{Other uses|Hat (disambiguation)}}

{{More citations needed|date=October 2024}}

A '''Help Authoring Tool''' or '''HAT''' is a software program used by [[technical writer]]s to create [[online help]] systems.<ref>{{Cite web |last=Heath |first=Catherine |date=2019-01-14 |title=Best Help Authoring Tools (HAT) & Software Compared for 2024 |url=https://document360.com/blog/help-authoring-tools/ |access-date=2024-09-12 |website=Document360 |language=en-US}}</ref><ref>{{Cite web |title=What is an help authoring tool ? |url=https://www.helpndoc.com/help-authoring-tool/ |access-date=2024-09-12 |website=www.helpndoc.com |language=en}}</ref>

==Functions==

Some common Help authoring tools include:

The basic functions of a Help Authoring Tool (HAT) can be divided into the following categories:

* [[Doc-To-Help]]: An authoring tool based on Microsoft Word

*[[FrameMaker|Adobe FrameMaker]]: The most common tool for large technical documents. Requires other tools to convert content to online Help.

===File input===

*[[Microsoft HTML Help SDK]]: A collection of tools for creating files in Microsoft's HTML Help format.

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.org|OpenOffice Writer]] and [[Microsoft Word]], and compiled Help formats such as [[Microsoft WinHelp]] and [[Microsoft Compiled HTML Help]].

*[[RoboHelp|Macromedia RoboHelp]]: A specialized tool for creating online help.

*[[Microsoft Word]]: Widely used for technical writing despite its limitations. Requires other tools to convert content to online Help.

===Help output===

*[[Epic Editor]]: An [[XML]]-based authoring tool.

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]].

*[[Microsoft Visio]]: Software for creating diagrams.

*[[Webworks Publisher]]: Converts documents in various formats to other formats, primarily [[HTML]].

===Auxiliary functions===

*[[AuthorIT]]: A collaborative authoring tool used for single-source content management.

Some HATs provide extra functions such as:

*[[Republicorp XDK]]: An [[XML]], [[HTML]], and Help toolkit based on Microsoft Word.

* Automatic or assisted [[Index (publishing)|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 toolsHATs include:

<!--

Do not add external links to commercial software here.

They are considered to be spam and will be removed.

-->

* [[HelpNDoc]]

* [[Adobe RoboHelp]]

* [[HelpSmith]]

* [[MadCap Software|Doc-To-Help]]

* [[MadCap Software|MadCap Flare]]

* Help & Manual

* [[Sandcastle (software)|Sandcastle]]

* [[AsciiDoc]]

==Related software==

Technical writers often use [[content management system]]s and [[version control system]]s to manage their work.

==See also==

[[category:Technical communication]]

* [[List of help authoring tools]]

* [[User assistance]]

{{Authority control}}

==References==

{{Reflist}}

{{DEFAULTSORT:Help Authoring Tool}}

[[categoryCategory:Technical communication]]

[[Category:Technical communication tools]]

[[Category:Help authoring tools]]