Selecting an Appropriate User Guide Topic
Selecting an appropriate user guide topic is not an exact science, but here are some guidelines to help you
narrow down your ideas:
 Avoid topics where the action occurs primarily in the mind and where the result is identifying a
strategy or making a decision (such as creating a marketing plan, choosing an appropriate
product, identifying stakeholders, etc.) Generally, these kinds of subjects are not purely
procedural because our minds rarely function in a strictly linear fashion.
 Rather choose topics that require some kind of physical manipulation and yield a tangible end
result (such as creating a tanjore painting, assembling a multi-media computer, throwing a pot,
laying concrete, etc.)
 Try to avoid procedures of physical movement without a tangible objective and that yield no
tangible result, as they can be difficult to document (such as swimming or yoga).
 Avoid topics that are primarily strategic (such as effective teaching or planning a vacation) as
these topics tend to yield a tips document rather than a complex and multi-dimensional manual.
 Cooking is generally not an appropriate subject as the end result would be a cookbook rather than
a user’s guide. Cooking (unless at a very advanced level) does not have enough concepts that are
sufficiently complex that are not obvious to the average reader.
 Commercial computer software applications are not an appropriate topic.
Procedures and Steps: Heading Off Confusion
A procedure (often called a task) is a set of distinct steps that create a single result. For example, a
procedure might be “Removing your nail polish.” This procedure has individual steps to remove the
polish: 1. Unscrew the lid of the nail polish remover, 2. Soak the cotton ball in the remover fluid, and
3. Scrub each fingernail until no remnants of the polish remain.” This process is one procedure with
distinct steps that must be completed in order.
A step is a single action with only one verb—such as “Unscrew the lid.” A group of steps that must be
completed in sequence to perform an objective (such as “Removing your nail polish”) is a procedure.
Sequential Steps vs. Sequential Procedures
A user’s guide must have multiple procedures. While steps within a procedure must be completed in
sequential order, the procedures themselves within one user guide may or may not be sequential.
For example, if you are writing a user guide on searching for books in your library, you may list several
kinds of searches (each of which is a distinct procedure). Each of the following types of searches would
be documented:
 Alphabetical Title Searching
 Call Number Searching
 Exact Match Searching
 Keyword Searching
The user will select only one kind of search to find their book. They need not perform all of the types of
searches if one is sufficient. Rather they choose the search that best meets their needs. These procedures,
therefore, are not chronological in nature (though they are made up of sequential steps).
M. Reber
6/27/2016
1
On the other hand, some user’s guides have procedures that must be completed in sequential order. For
example, X-ray film developing includes five procedures that must be completed in sequential order:
Developing
Film
Rinsing
Film
Fixing
Film
Rerinsing
Film
Drying
Film
Each of the procedures above is comprised of sequential steps. And each procedure must be done in
order. You must rinse the film before you can fix, rerinse, and dry it.
Practice
Identify if each of the following topics is a true procedure comprised of distinct steps that must be
completed in sequential order:
Yes / No
1.
Overview of the basic parts of a C program. Describes the most basic components that
constitute most C programs, including their concepts and usage.
Yes / No
2.
Collecting data about the network. Describes what the network will be used for, by how
many people, and for how long.
Yes / No
3.
Jumping a battery. Describes the process to safely jump a battery from attaching the jumper
cables to starting the car.
Yes / No
4.
Defining the document. Analyze the whole situation and decide what to do about it. Analyze
audiences, information each audience needs and most appropriate media.
Yes / No
5.
Choosing A/V components. Describes how to choose the right components for your home
theater such as an audio/video receiver, CD player, DVD player, TV, and speakers.
Yes / No
6.
Selecting the appropriate food and method of preservation. Describes which fruits and
vegetables preserve easily, the best period of maturity, and the best method for each food.
Yes / No
7.
Fertilizing. Describes when and what type of fertilizer is suitable for container gardens.
Yes / No
8.
Pest and Weed Control. Explains what kind of pests and diseases commonly affect plants.
Yes / No
9.
Generating Specifications. Describes the process of writing an engineering specification,
including analyzing the marketing requirements, reviewing, negotiating, and approving.
Identify which of the following groups of procedures are sequential:
Yes / No
1.
Maintaining your Home: Provides procedures for basic home maintenance such as plumbing,
cleaning, electrical wiring, redecorating, inspecting smoke detectors, etc.
Yes / No
2.
Giving a Pedicure: Explains how to give a pedicure including cleaning the feet, buffing off
dead skin, trimming the nails, filing the nails, massaging the feet, and painting the nails.
Yes / No
3.
Building a Home Theatre System. Explains how to setup AV equipment, connect A/V
equipment, set up speakers, prepare speaker wires, connect speakers, and test the system.
M. Reber
6/27/2016
2