Help authoring tool: Difference between revisions

Revision as of 16:40, 27 January 2016

Latest revision as of 11:24, 4 July 2025

(26 intermediate revisions by 22 users not shown)

Line 1:

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

{{Other uses|Hat (disambiguation)}}

{{UnreferencedMore citations needed|date=DecemberOctober 20092024}}

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==

The basic functions of a Help Authoring ToolsTool (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,. thoughAcceptable theyfile formats can include such formats as [[ASCII]], [[HTML]], [[OpenOffice.org|OpenOffice Writer]] and [[Microsoft Word]], and compiled Help formats such as [[Microsoft WinHelp]] and [[Microsoft CompressedCompiled 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===

Line 22 ⟶ 23:

* Import and export of text in [[XML]] files, for exchange with [[computer-assisted translation]] programs

==Common Helphelp Authoringauthoring Toolstools==

Some common HATs include:

<!--

Line 28 ⟶ 29:

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

* HelpConsole

* [[Help & Manual]]

* WebWorks ePublisher

* [[Help Generator]]

* HelpIQ

* [[HelpNDoc]]

* HelpSmith

* [[Sandcastle (software)|Sandcastle]]

* [[AsciiDoc]]

==Related software==

Line 46 ⟶ 44:

* [[List of help authoring tools]]

* [[User assistance]]

{{Authority control}}

==References==

{{Reflist}}

{{DEFAULTSORT:Help Authoring Tool}}

[[Category:Technical communication]]

[[Category:Technical communication tools]]

[[Category:OnlineHelp helpauthoring tools]]