Common Desktop Environment: Help System Author's and Programmer's Guide

Testing Your Help

Testing your help volume is as important as testing any software product. Here are some tips to help you plan your testing.

Validating Hyperlinks

Verifying Entry Points

If you are writing application-specific help that uses IDs to access particular help topics, there are two ways to verify that the IDs have been properly established within the help volume:

Checking Index Entries

Users search or browse a help volume index to find help topics. Examine your index entries carefully to eliminate any vague terms or duplicate entries. Also select each index entry to verify that the topic displayed is the most appropriate information.

Testing Graphics

Checking for Parser Errors

When developing a help volume, it is often convenient to set the onerror=go option in the helptag.opt file. If you have done this, you should remove the option and process your source files a final time to ensure that no errors are encountered.

See Also