Help authoring tool

Last updated

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

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

Related Research Articles

<span class="mw-page-title-main">PDF</span> Portable Document Format, a computer 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.

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.

<span class="mw-page-title-main">Adobe FrameMaker</span> Document processor for the production and manipulation of large structured documents

Adobe FrameMaker is a document processor designed for writing and editing large or complex documents, including structured documents. It was originally developed by Frame Technology Corporation, which was bought by Adobe.

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.

<span class="mw-page-title-main">Help & Manual</span>

Help & Manual is a Windows-based help authoring tool published by EC Software, a company based in Austria.

<span class="mw-page-title-main">Adobe Captivate</span>

Adobe Captivate is an authoring tool that is used for creating eLearning content such as software demonstrations, software simulations, branched scenarios, and randomized quizzes in HTML5 format.

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

This is an overview of software support for the OpenDocument format, an open document file format for saving and exchanging editable office documents.

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.

Sandcastle is a documentation generator from Microsoft. It automatically produces MSDN-style code documentation out of reflection information of .NET assemblies and XML documentation comments found in the source code of these assemblies. It can also be used to produce user documentation from Microsoft Assistance Markup Language (MAML) with the same look and feel as reference documentation.

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

<span class="mw-page-title-main">Bean (software)</span> Word processor for Mac OS X

Bean is a word processor for Mac OS X. Originally free and open source software Bean became closed source at version 3. However, the Bean executable is still distributed free of charge. According to its author, James Hoover, Bean is not meant to replace Microsoft Word, but to be a lean word processor that is beautiful and user friendly. Many of Bean's operations are carried out by the underlying Cocoa framework of Mac OS X. The name Bean is a play on Cocoa and Java, two popular programming frameworks.

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

Google Docs is an online word processor included as part of the free, web-based Google Docs Editors suite offered by Google, which also includes: Google Sheets, Google Slides, Google Drawings, Google Forms, Google Sites and Google Keep. 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.