Find » Technology » Tutorials » How to Choose a Help Authoring Tool

How to Choose a Help Authoring Tool

By Cory Sandermere, published Nov 21, 2007
Published Content: 34  Total Views: 17,924  Favorited By: 0 CPs
Embed:  
Rating: 3.0 of 5
When you pour your energy into creating a great software application, you don't want to settle for second-rate documentation. After all, what good is a piece of software that nobody knows how to use? You want to give users the most complete and instructive online help possible so they can appreciate the full capabilities of your software.

But with so many help authoring tools available, how do you choose one that meets your needs?

First, take a close look at the system requirements for your software. These requirements will often help narrow down your options, because the help format you choose must be compatible with the computer systems owned by your users.

Several help formats are available. Browser-based help formats will run on most modern computers as long as they have an Internet browser, such as Internet Explorer or Mozilla Firefox, installed. Other online help formats may require a run-time environment such as the Java Runtime Environment for viewing JavaHelp, or a proprietary help viewer such as Microsoft's HTML Help. Many of these help viewer applications can be downloaded for free by your users. Others may come pre-installed with the operating system and may only be available for that particular operating system. The amount of RAM available will also impact your choice; some help formats require more memory than others to run. When choosing a help format, you will have to keep all of these system requirements in mind.

After you have chosen a help format, start researching the available tools for producing online help in that format. Google is a great place to start; just use the help format as a search keyword. Your search results will likely turn up several help authoring tools. Most help authoring tools are capable of producing output in a variety of formats. Make a list of these tools that support your desired format.

Comments
Type in Your Comments Below - (1000 characters left)
Your name:

Submit your own content on this or any topic. Get started »
Most Commented On