TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: Writing simple procedures From:Gail Hodgson <gail -at- HPATO -dot- AUS -dot- HP -dot- COM> Date:Fri, 5 May 1995 13:42:47 EST
Glenda Jeffrey wrote:
> The trouble is that our customers seem to run the gamut, from
> inexperienced folks who really aren't terribly computer literate,
> to people who work with sophisticated CAD programs all day long.
> I'm also dealing with an international audience, so I tend to
> think more explanation is better.
One good way I've seen people handle this problem is to separate the
procedural step from the additional information. You can do this using a
two column format, or by having a bold step followed by an explanation.
For example
1. Select the ??? icon. Move the mouse until the cursor is
positioned over the ??? icon; then
click the left mouse button.
1. *Select the ??? icon.* <-- imagine this bit is bold
Move the mouse .... etc. <-- not bold, and maybe even a smaller point size
Your experienced users can scan down the left column or bold steps
without having the explanation slow them down. Other users can refer
to the additional information when they need it.
Gail Hodgson
gail -at- hpato -dot- aus -dot- hp -dot- com
