My Experience with Dr.Explain

by Victor Wheeler
 
×
Menu
 

Variables

 
The name of the application I am documenting is:
 
HM GP Shifter Configuration Tool
 
and the name of the device is
 
HM GP Shifter.
 
Both of these names appear probably 50 times each in my help file, and they need to be identical every time they appear.  Do I want to type these names 50 times each?  What if the name changes slightly?  Then normally I would have to go through my help file and change it in 50 places!  Good luck finding them all.  If I made a typo in one of them, then a "Find and Replace" operation isn't going to find it!
 
However, I can do it much more easily -- both for the initial TYPING and for CHANGING the names (if ever necessary).
 
In actual fact, it the device name DID change to "HM Quickshifter GP" which also changed the name of the Windows software application, after the help file was produced, and before the release!  Boy, do I feel lucky!!  Read on...
 
 

Enter Variables:

 
In Project settings > Variables I can create a list of variables where each variable is simply a "place holder" for the actual text.  So when I am typing help content, each time I need to enter the name of the application, I type this instead:  Ctrl-Shift-R (pulls up the Variable dialog), then I pick the variable I want (if it is not the first one), and hit Enter and I'm done!
 
If either of those names ever change (again), I simply go to Project settings > Variables and change it once, and re-generate my help file.
 
Another nice productivity booster!  (This is a standard feature in most help-authoring tools I looked at.)
 
The online help was created with Dr.Explain