My Experience with Dr.Explain

by Victor Wheeler
 
×
Menu
 

Orientation to the Product Being Documented

 
Though you as the reader don't need to really understand the application I am documenting, since this article is more focused on how I used Dr.Explain to build a help file, you will probably notice some unusual terms.  So that you don't get totally lost, I will orient you a bit:  there are two parts to the final product I am documenting in this project:  the first one is a device the "lives" on a motorcycle.  It is called a Quickshifter and its job is to provide extremely fast shifts for serious motorcycle racers and racing teams.  The features and details of this Quickshifter are the subject of the first part of my document.
 
That Quickshifter also plugs into a PC or laptop through a USB cable and talks to a Windows software application used to control settings on the Quickshifter.  I wanted to orient you (the reader) to this because you are going to see things like "RPM" and other automotive terms and realize that this is not your usual "desktop" application.
 
Now that that's out of the way, let's get on with creating the help file.
 
The online help was created with Dr.Explain