Open main menu
Home
Random
Recent changes
Special pages
Community portal
Preferences
About Wikipedia
Disclaimers
Incubator escapee wiki
Search
User menu
Talk
Dark mode
Contributions
Create account
Log in
Editing
Help authoring tool
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
{{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 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.org|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: * 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 HATs 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== Technical writers often use [[content management system]]s and [[version control system]]s to manage their work. ==See also== * [[List of help authoring tools]] * [[User assistance]] {{Authority control}} ==References== {{Reflist}} {{DEFAULTSORT:Help Authoring Tool}} [[Category:Technical communication]] [[Category:Technical communication tools]] [[Category:Online help]]
Edit summary
(Briefly describe your changes)
By publishing changes, you agree to the
Terms of Use
, and you irrevocably agree to release your contribution under the
CC BY-SA 4.0 License
and the
GFDL
. You agree that a hyperlink or URL is sufficient attribution under the Creative Commons license.
Cancel
Editing help
(opens in new window)
Pages transcluded onto the current version of this page
(
help
)
:
Template:Authority control
(
edit
)
Template:Cite web
(
edit
)
Template:More citations needed
(
edit
)
Template:Other uses
(
edit
)
Template:Reflist
(
edit
)