Help authoring tool

Last updated

A Help Authoring Tool or HAT is a software program used by technical writers to create online help systems. [1] [2]

Contents

Functions

The basic functions of a Help 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 by using an editor. File formats that can be imported vary from HAT to HAT. Acceptable file formats can include ASCII, HTML, OpenOffice Writer and Microsoft Word, and compiled Help formats such as Microsoft WinHelp and Microsoft Compiled 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

Some HATs provide extra functions such as:

Common help authoring tools

Some common HATs include:

Technical writers often use content management systems and version control systems to manage their work.

See also

  1. Heath, Catherine (2019-01-14). "Best Help Authoring Tools (HAT) & Software Compared for 2024". Document360. Retrieved 2024-09-12.
  2. "What is an help authoring tool ?". www.helpndoc.com. Retrieved 2024-09-12.

Related Research Articles

<span class="mw-page-title-main">PDF</span> Portable Document Format, a digital file format

Portable Document Format (PDF), standardized as ISO 32000, is a file format developed by Adobe in 1992 to present documents, including text formatting and images, in a manner independent of application software, hardware, and operating systems. Based on the PostScript language, each PDF file encapsulates a complete description of a fixed-layout flat document, including the text, fonts, vector graphics, raster images and other information needed to display it. PDF has its roots in "The Camelot Project" initiated by Adobe co-founder John Warnock in 1991. PDF was standardized as ISO 32000 in 2008. The last edition as ISO 32000-2:2020 was published in December 2020.

The Rich Text Format is a proprietary document file format with published specification developed by Microsoft Corporation from 1987 until 2008 for cross-platform document interchange with Microsoft products. Prior to 2008, Microsoft published updated specifications for RTF with major revisions of Microsoft Word and Office versions.

In computing, formatted text, styled text, or rich text, as opposed to plain text, is digital text which has styling information beyond the minimum of semantic elements: colours, styles, sizes, and special features in HTML.

Microsoft WinHelp is a proprietary format for online help files that can be displayed by the Microsoft Help browser winhelp.exe or winhlp32.exe. The file format is based on Rich Text Format (RTF). It remained a popular Help platform from Windows 3.0 through Windows XP. WinHelp was removed in Windows Vista purportedly to discourage software developers from using the obsolete format and encourage use of newer help formats. Support for WinHelp files would eventually be removed entirely in Windows 10.

A number of vector graphics editors exist for various platforms. Potential users of these editors will make a comparison of vector graphics editors based on factors such as the availability for the user's platform, the software license, the feature set, the merits of the user interface (UI) and the focus of the program. Some programs are more suitable for artistic work while others are better for technical drawings. Another important factor is the application's support of various vector and bitmap image formats for import and export.

The following tables compare general and technical information for a number of office suites:

The Extensible Metadata Platform (XMP) is an ISO standard, originally created by Adobe Systems Inc., for the creation, processing and interchange of standardized and custom metadata for digital documents and data sets.

Microsoft Assistance Markup Language is an XML-based markup language developed by the Microsoft User Assistance Platform team to provide user assistance for the Microsoft Windows Vista operating system. It makes up the Assistance Platform on Windows Vista.

AsciiDoc is a human-readable document format, semantically equivalent to DocBook XML, but using plain-text mark-up conventions. AsciiDoc documents can be created using any text editor and read “as-is”, or rendered to HTML or any other format supported by a DocBook tool-chain, i.e. PDF, TeX, Unix manpages, e-books, slide presentations, etc. Common file extensions for AsciiDoc files are txt and adoc.

The following is a comparison of e-book formats used to create and publish e-books.

<span class="mw-page-title-main">MadCap Software</span>

MadCap Software is an American computer software firm headquartered in San Diego, California that creates help authoring tools and solutions for technical writers and documentation teams. Several principal managers, software engineers, and support personnel were recruited from rival firms, such as Adobe Systems and Macromedia, to found MadCap Software. MadCap's authoring tools are all based on xHTML.

Swordfish Translation Editor is a Computer-assisted translation software.

memoQ is a proprietary computer-assisted translation software suite which runs on Microsoft Windows operating systems. It is developed by the Hungarian software company memoQ Fordítástechnológiai Zrt., formerly Kilgray, a provider of translation management software established in 2004 and cited as one of the fastest-growing companies in the translation technology sector in 2012, and 2013. memoQ provides translation memory, terminology, machine translation integration and reference information management in desktop, client/server and web application environments.

<span class="mw-page-title-main">Google Docs</span> Cloud-based word processing software

Google Docs is an online word processor and part of the free, web-based Google Docs Editors suite offered by Google. Google Docs is accessible via an internet browser as a web-based application and is also available as a mobile app on Android and iOS and as a desktop application on Google's ChromeOS.