Context-sensitive Help development is one of the most intricate functions of online Help projects. Both Help authors and application developers are involved in this process. When roles are clearly defined, developing context-sensitive Help is a straightforward process.
The following information provides a basic description of how each role fits into the process:
Author |
Developer |
Creates Help topics that describe how to use the various components in the application (windows, dialogs, fields, controls). |
Builds the components (windows, dialogs, fields, controls) that make up the application. |
Imports map files and associates topic IDs with specific context-sensitive Help topics. |
Generates the map files that contain the topic IDs. |
Compiles the project to include the context-sensitive Help with the HTML Help system (or generates WebHelp output for applications that run on non-Windows platforms). |
Writes code that "calls" the correct Help topics from within the application (based on map numbers included in the map files). |
Tests the context-sensitive topics in the application to make sure they work properly and repairs any errors. |
Notifies the author whenever changes are made to the application (or map files) so the Help project can be updated. |
Note: Some authors create the map files or they have RoboHELP automatically generate them. Authors and developers should decide how to prepare the map files before the project begins