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: Another Newbie question about procedures From:John Posada <jposada01 -at- yahoo -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 18 May 2005 07:24:45 -0700 (PDT)
> Some other types of procedural steps I can't stand:
Some questions:
> 3) The XYZ screen displays.
> [What is the user supposed to do here? This isn't a step - there's
> no user action.]
Do you have a problem with it phrased as the result of a step?
3) Click the XXX button.
The XYZ screen, as shown in fig 2-1 is displayed
(BTW...let's not get into a "display" discussion)
> 5) Enter the user name.
> 6) Or search the database and select the user name.
> [Either/or actions should be one step - users aren't going to
> follow both of these steps.]
agreed
> 9) Enter the user address in the XYZ field and select the
> privileges associated with the user in the Privileges area of
> the Users Are Us window.
> [If it's two steps - write it as two steps.]
I'm not so black/white on this one. If the "Privileges area" is a
byproduct of entering the user address, in other words, a sub-screen
from the one they enter the user address and if they close the user
address dialog, they cannot get to the next dialog, I'd leave them combined.
John Posada
Senior Technical Writer
?Never be afraid to try something new. Remember that a lone
amateur built the Ark. A large group of professionals built
the Titanic.? - Dave Barry
New from Quadralay Corporation: WebWorks ePublisher Pro!
Completely XML-based online publishing. Easily create 14 online formats, including 6 Help systems, in a streamlined project-based workflow. Word version ships in June, FrameMaker version ships in July. Sign up for a live, online demo! http://www.webworks.com/techwr-l
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.