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.
My initial training stressed the need to atomize the steps in a
procedure. In other words, each sentence should include one action.
However, I've noticed many people, most notably Microsoft, now including
several actions in a single step when that step describes how to navigate to
a menu option.
>>>
As a tech writer and as a user, I generally prefer the "atomized" approach.
When I'm installing new software, changing the setting on a VCR, etc., I'm
usually excited to see what the final result will be. For that reason, I
tend to skip embedded actions. The atomized approach helps prevent this
circumstance. The same thing goes for when I write a procedure. By writing
one action, then the result, I not only make the procedure easier to follow,
but I ensure that I don't forget to include all the actions. If the
situation warrants it, I'll write embedded actions, but that doesn't seem to
happen often.
The atomized approach, however, requires more page space.
Dave
(Any statements made above are mine, and mine alone.)
