5 Ways to Highlight Where Procedures Are Performed


What do we mean by the location in procedures? What we mean is WHERE does the user perform this actual task. This might seem obvious but what can happen is:

  • The writer assumes the reader will know where to perform the action.
  • The place in the application, for example, a menu option is in different places in different versions on the software. A good example of this is when you switch from Windows XP to Vista. Where is everything?
  • The location is only displayed if you do something first, for example, select a check box and then a window appears.

So, as procedure writers, we need to put ourselves in the readers shoes, for example:

  1. Location – identify where in the application the procedure is performed, for example, [this task] is performed  on this [tab] on [this] window.
  2. Prerequisites – highlight if it’s necessary to perform any tasks, for example, selecting a checkbox on another window in order to make another window appear. Another consideration is if this window needs to be specified in a configuration file or selected from a menu bar if it’s not displayed out of the box.
  3. Location in user interface – identify where in the application the task is performed. Provide directions to the exact location where the procedure is performed, for example, if the window contains several panes, then highlight either with a graphic or state the name of the pane. Likewise, if the window has tabs, highlight which tab to use.  Use the same convention to define the location path in other procedures.
  4. Position in Procedure – decide to add these directions, for example, directly after the first lead paragraph, so the reader can identify the location immediately. Remove any frustration for the user by orienting them in the application. This helps them perform the procedure without having to go to other pages to determine the location.
  5. Links – if linking to the page, for example, in online help, use the same phrasing in your links. Instead of saying Click Here, provide more useful information, for example, to create a report, see the Report window, and then link Report window to the appropriate page.

What else would you add?