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:"Jones, Donna" <DJones -at- zebra -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Mon, 16 May 2005 16:28:29 -0500
> -----HBachelor -at- aol -dot- com wrote:-----
> In a message dated 5/16/05 1:33:57 P.M. Eastern Daylight Time,
> jmalin -at- tuvox -dot- com writes:
> To confirm your settings, click OK, or to exit the screen without
> saving click Cancel.
> Wouldn't it be better to write it as:
>
> 5. Click OK to confirm your settings. Click CANCEL to exit
> without saving
> your settings.
You could also use the Information Mapping method of including an if/then table as part of the step. It takes up a little more space and maybe adds a couple of extra words, but it doesn't get more clear. It gives you the reason for the instruction first and makes it easy to scan, as Joe said is important to him.
5. Save new settings, or discard changes.
---------------------------------------
If you wish to... Then click...
---------------------------------------
Save new settings OK
Repeat this table any place that they have to make that decision. Your users will get used to looking for it and will find what they need at a glance.
Donna
Donna L. Jones
--------------------------------------
Technical Writer II
Zebra Technologies Corp.
Vernon Hills, IL
djones -at- zebra -dot- com
- CONFIDENTIAL-
This email and any files transmitted with it are confidential, and may also be legally privileged. If you are not the intended recipient, you may not review, use, copy, or distribute this message. If you receive this email in error, please notify the sender immediately by reply email and then delete this email.
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.
