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've been doing some research into using procedural
> steps, as in:
> 1. Select some text.
> 2. Click the B button.
> 3. Do something else.
> I've been looking into several issues, but noticed
> that some commercial software manuals (as in the
> Dummies books, XXX Made Easy, ABCs of XXX,
> and similar series) often do not consistently
> or regularly number the steps.
> I've always assumed that each numbered step should
> reflect an action on the part of the reader. That is,
> if there are three things the reader must do,
> there should be three steps. I've found that many
> books present the information as
> 1. Select some text.
> 2. The text will appear highlighted on the screen.
> 3. Click the B button.
> 4. The text will be boldfaced.
> 5. Do something else.
I don't have the latest usability studies, but I use a combination of the
two methods above. I think it's important not to number non-steps, yet
sometimes further information is necessary to help the user. I also think
it's important to number steps so the user can see at a glance what the
process is. So, I do something like the following:
1. Select some text. The text will appear highlighted on the screen.
2. Click the B button. The text will be boldfaced.
3. Do something else.
Actually, I might set off the step from the explanation like so:
1. Select some text.
The text will appear highlighted on the screen.
2. Click the B button.
The text will be boldfaced.
3. Do something else.
That way, the steps stand out a bit more.
Ann Amsler
Information Resource Consultant
User Services, University of Delaware