Help authoring tool: Difference between revisions

Revision as of 09:12, 11 August 2006

Latest revision as of 11:24, 4 July 2025

(215 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]]s to create [[online help]] manuals.

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

The basic functions of help-authoringa toolsHelp Authoring Tool (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 usingby ausing textan 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 helpHelp formats such as [[Microsoft WinHelp]] and [[Microsoft CompressedCompiled 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 specialisedcompiled helpHelp file in a format, such as [[WinHelp]] (*.HLP) or [[Microsoft Compiled HTML Help]] (*.CHM), or a general-purpose documentnoncompiled file formats such as Adobe [[PDF]], or[[XML]], [[HTML]] or [[JavaHelp]].

=== Auxiliary functions ===

Some HATs provide extra functions such as:

* Automatic or assisted [[Index (publishing)|indexIndex]] generation

* Automatic [[tableTable of contentsContents]]

* [[Spelling checker]]

* Image editing

Line 20 ⟶ 23:

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

Some common help authoring tools include:

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

==See also==

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

* [[List of help authoring tools]]

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

* [[User assistance]]

*[[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.

*[http://www.vizacc.com/gen_download.php HelpMaker] Free, user-friendly WYSIWIG help authoring tool the outputs in WinHelp, HTML Help, [[PDF]] and other formats.

*[http://www.helpndoc.com/ HelpNDoc]: Free for personal use, easy to use, WYSIWYG, creates HTML Help and web pages.

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

*[http://www.olsonsoft.com/ HyperText Studio]: WYSIWYG Help authoring tool for creating WinHelp, HTML Help, Browser based help and print documents.

*[[MadCap Flare]]: WYSIWYG XML authoring tool

*[[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.

*[http://www.excelsoftware.com/quickhelpwin.html 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.

*[http://www.softany.com/winchm WinCHM]: An easy-to-use [[HTML]] help authoring tool.

*[http://www.xmetal.com/en_us/products/xmetal_author_dita/index.x XMetaL Author DITA Edition]: An [[XML]] editor optimized for single-source output (including online help) based on the [[DITA]] standard.

*[http://www.digipedia.nl digipedia] from the makers of [http://www.sevensteps.com Sevensteps].

{{Authority control}}

See [http://www.mshelpwiki.com/index.php?page=AvailableTools: MSHelpWiki] for a list of all available Help authoring tools.

==References==

== Related software ==

{{Reflist}}

{{DEFAULTSORT:Help Authoring Tool}}

[[Category:Technical communication]]

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

[[categoryCategory:Technical communication tools]]

[[Category:Help authoring tools]]