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.
Re: Do you include a sentence identifying the dialog name?
Subject:Re: Do you include a sentence identifying the dialog name? From:Jim Hager <jhager -at- techrx -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 8 Feb 2002 08:50:02 -0500
Hi,
Yes. I inlude a sentence identifying the dialog box.
I agree with Steve Brown on this about the "Do This. That happens" scenario.
It seems to me that we need to reassure the reader that they are performing
the procedure correctly and this is a great way to do that.
I typically do it like this and would like any comments (note that the
resulting action is on a separate line so it is easier for the reader to
see):
To find the framizan you want:
1. In the ABC window, select the XYZ button.
The system opens the XYZ dialog box.
<graphic of thte XYZ dialog box>
2. In the XYZ dialog box, type the name of the framizan you want.
3. Select OK.
The system opens the Detail window and displays information about the
framizan you selected.
<graphic of the Detail window>
etc.
Jim Hager
jhager -at- techrx -dot- com
---------- Original Message ----------
Subject: Re: Do you include a sentence identifying the dialog name?
From: Steven Brown <stevenabrown -at- yahoo -dot- com>
Date: Thu, 7 Feb 2002 09:13:03 -0800 (PST)
X-Message-Number: 41
One of the best editors I've worked with suggested
that I write procedures using a cause-effect model.
That is, "Do this. That happens." That model
accomplishes two things. It tells the user what to do,
and it tells them what will result.
So in your situation, I'd keep the second sentence as
follows:
(I added "box" per the Microsoft Manual of Style --
God forbid!)
Steven Brown
Senior Technical Writer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Did you know you can get RoboHelp certified?
To learn how, visit http://www.ehelp.com/techwr. Be sure to also check out
our special pricing offers and promotions for RoboHelp 2002.
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
