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.
> I don't have any information about usability tests, but we've been
> putting together some help files that have numbered steps, so I do
> have a few comments.
> 1) The "numbered non-steps" may be annoying, but I have just as big
> a problem with something like:
> #1 From the Windows menu, select Options. The options window will
> #open on
> the right hand side of the screen.
> As you can see, I have combined the step with the non-step. But to
> my mind it defeats the purpose of creating a numbered list: to
> present *short*, easy to follow steps. When you look at a numbered
> list, and each item in that list is multiple lines, it takes away
> from the simplicity of the format. And in help files, you do have
> to try to be simple when guiding somebody through the steps.
I agree that the paragraphs without numbers can sometimes bury the
procedural steps. When I have a very complex sequence of steps with each
step requiring a lot of explanation, I prefer the two-plan approach.
First I explain in an overview what the steps are using numbered
lists of only a couple words (for example,"back up your files" or
"edit the configuration files"). Then I explain that the following
sections will provide detailed information for each step.
This approach works well because the users/readers can see at a
glance what they're getting into and gives them a sense of confidence
that it really is not so complicated. In fact, some "power users" may
not even need the details (although unlikely in our case).
Hope this helps someone.
janeb -at- airmail -dot- net