|
Checklist of key criteria for selecting a so-called help authoring tool (HAT). Help authoring tools can be used to create both user manuals and online help files from the same source (single source publishing principle).
Help authoring tools (HATs) are specialized editors and converters to create online technical documentation. Today, many help authoring tools also provide features for single source publishing, which means that you can generate several output formats and versions from one shared text source. While most tools manage to produce different online formats like browser-based help and compiled help very well, only few tools can also produce printed user manuals (or PDF) of professional quality. Big differences also exist between the tools when it comes to translating your projects into foreign languages.
You can find a list of recommendable tools under Help Authoring Tools.
The primary differentiating characteristic of the help authoring tools on the market today is the question of where and how the writer puts together his texts and formats them.
| ▪ | Tools with an integrated editor
The majority of help authoring tools have their own fully integrated WYSIWYG editor. |
Advantage: Texts and meta-information can be created and managed together. There will be no additional license costs for an external editor. Only one software package has to be installed and updated.
Disadvantage: The integrated editors often do not provide the same comfort and efficiency as the major text processors. If you want to use macros or autotext / building blocks, for example, you will often have to use a third-party utility.
| ▪ | Tools with an external editor |
Other tools follow the contrary approach and use an external editor for creating the texts – mostly Microsoft Word, but also, to an increasing extent, FrameMaker, HTML editors, or XML editors.
Advantage: You can use all functions of your favorite editor.
Disadvantage: Often, inefficient and complex operation. Also, since the source data are mostly loaded with additional meta-information (e.g., in the form of hidden texts or with the help of field functions), the translation process becomes particularly error prone. Add to this the typical, well-known problems of the various editors. For instance, those who are reluctant to work with Microsoft Word will never be happy with a tool that integrates Microsoft Word.
In this group, text creation and help generation are largely decoupled. Complete user manuals (mostly written with Microsoft Word or FrameMaker) will be converted into online help only in the second step. The basis for formatting is usually a specific template, which must be adhered to strictly while writing the texts. Moreover, even here, often some additional meta-information will have to be incorporated in the text.
Advantage: This procedure allows for efficient single source publishing especially if the material already exists in the form of printable user manuals.
Disadvantage: The book metaphor can mislead the author easily into writing contents that are not as modular as required for online help. The results often are "screen manuals" instead of media-adapted online help. Another disadvantage is the fact that the documentation for different product versions can hardly be generated from the same source.
Other converters are based on XML-DITA. This avoids the disadvantages listed above, as it forces the author to develop a modular, online-ready structure right from the beginning.
|
If online help needs to be Unicode-compatible for certain languages, this will restrict the choice of tools. Not all programs support Unicode. There are also significant differences in the translation workflow. Many tools completely ignore translation requirements. Others provide sophisticated export and import options for texts that are to be sent out to external translators, or allow the author to edit several languages in parallel.
|
Unlike with content management systems, only a few of the classical help authoring tools explicitly support the simultaneous editing by several authors. In some cases, this can also be achieved manually to a certain extent at the file level, but this only works for the tools that save each topic into an individual file. If your team is working at different locations, a remote access might be required.
Other questions are:
Does the tool have a built-in version control system or can it be connected to an external VCS?
Does the tool provide any support for the review process?
Does the tool provide some possibility for subject matter experts to contribute information in an efficient and easy way?
|
The majority of tools claim to support single source publishing, which means creating texts once, and then publishing to different formats and media. As long as these are just different help formats, such as compiled help or browser-based help, this usually works smoothly. However, when it comes to also generating printable user manuals or PDFs, the following aspects are what separates the grain from the chaff:
| ▪ | Is it possible to fine-tune the formatting of the exported documents? Many tools, for instance, do not export the names of paragraph and character styles. Thus, it becomes hardly feasible to achieve a professional print layout automatically. |
| ▪ | Is it possible to automatically eliminate or insert media-typical text fragments, such as "on page" or "in chapter"? |
| ▪ | Can the export be restricted to specific contents? |
Single source publishing acquires one more dimension if documentation not only for different media but also for different product versions have to be generated from the same source, like for a standard-version and a pro-version, for example. Some tools allow you to define so-called conditional texts or build flags to hide specific sections of the text as required. Other important features are variables and text snippets (sometimes also called embedded topics), which allow you to use individual text sections many times over such as product names or a warning, for example.
|
Can the production of documentation for multiple product versions be automated? Is it possible to invoke the tool from the command line or from scripts? Can the tool be invoked along with all the settings and parameters that are required?
Can the tool be integrated into an overall build process?
|
Some tools have specialized on code, assembly and component documentation. They scan the source code and automatically generate a completely linked basic framework for the documentation. Citations from the source code will be formatted automatically (syntax highlighting feature).
|
Many low-cost tools can prove to be a costly exercise when a project grows lager than initially expected, or when it has to be revised later on. Most low-cost tools do not support definable paragraph and character styles and format each word manually. When a global change to the layout becomes necessary at some time in the future, then comes the rude awakening.
Only for those who only need to create a small online help occasionally and do not have to maintain and update this help file regularly, a low-cost solution will truly be an economical alternative.
|
Although all current help formats are backed by the source format HTML, only a few tools give you full control over the generated HTML, JavaScript and CSS-code. Here you will have to make a fundamental decision: Do you want to be able to tune the code manually, or are you rather looking for a tool that will spare you from most technical details?
|
Finally, there are some questions regarding performance, efficiency, and the scope of functions:
| ▪ | Is there support for advanced navigation features such as expandable sections, breadcrumb trail, related-topic-links, mini TOCs? |
| ▪ | Is it possible to call browser-based help in a context sensitive way? Or will only the home page (index.html) appear? |
| ▪ | How easy is it to import legacy data from other tools? |
| ▪ | What other useful functions does the software provide? Some tools for instance, come with useful add-ons such as screen capture utilities or tools for image processing. |
|
Apart from the set of features of the tool, and its performance and usability, you should also take into account the following worst-case scenarios:
| ▪ | What will happen if the manufacturer of the tool discontinues the product or ceases operations? Does your tool require a server run by the manufacturer? Does your tool require activation when installed on a new computer? Will you be able to continue the use of the tool at least for some limited time? |
| ▪ | How easily can you migrate your source files when you have to (or want to) switch to another tool in the future? Does the tool use open formats like XML / DITA to store its data? Can you only migrate some output, or can you migrate your projects along with all their meta data? |
Even if these scenarios seem unlikely today, ignoring them might become very expensive one day – probably much more expensive than the additional license fee for a more suitable tool.
|
Keywords relating to this page: tool - software - program - utility - help authoring tool - HAT - online help authoring tool - online help creation tool - online help development tool - online help authoring program - online help authoring utility - help compiler - online help tool - documentation tool - software documentation tool - online help - online help files - creation - creating - selection - selecting - choosing - decision - deciding - criteria - checklist.
|