Help authoring tool: Difference between revisions

Revision as of 19:04, 1 February 2006

Revision as of 19:51, 1 February 2006

Line 1:

A '''Helphelp-authoring tool''' or '''HAT''' is a software program used by [[Technicaltechnical writer|technical writers]]s to create [[online help]] manuals.

== Functions ==

Some common Help authoring tools include:

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 (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 Helphelp authoring tools include:

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

Line 22 ⟶ 43:

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

== Related software ==

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