Home » Technical Writing » Integrated Help
 
Integrated Help

Context-Sensitive Help

A computer user is running an application program. He has a screen before him that he is trying to figure out. Maybe there is a parameter that he is expected to fill in; but he doesn't know what to do with it. Maybe there is an error message he doesn't understand. He needs "help" to go on working. He touches the F1 (Help) key or clicks on the Help button.

The application program then opens an Internet Explorer window that takes him to EXACTLY the place in the huge manual that explains what he NEEDS to know. A lot of programs do less than this. They 1) do nothing 2) tell him that no help is available 3) open up the www.website.com that produces the program 4) they give a phone number to call 5) they open up a site that gives a series of FAQs to look at; etc. This is NOT good and doesn't help the user.

The best thing to do is to take him to the place in the manual where that feature is explained. There has to be intelligence in the program to make this happen. We provide programmers with the "technology" to link the program with the manual. We give them the "secret" of how to do this.

In a few words, this is how we do it.

The "HELP" button is directed to a table that is a list of pointers. The pointers open up the HTML based manual file with Internet Explorer that deals exactly with the specific problem. This is all integrated (put together) inside the host computer. The Internet may or may not be involved. The program keeps running but attention is on the manual. They can move around in the manual: go to the Index, follow links and so forth. They then close the Help window with real Help to the problem, and go on with their program. It is a good solution for HELP.