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.
Brian,
Can I take it your user is looking at a dialog box with several
properties that they have to set? If so, have you considered using a
table to list those properties and summarize what they do? Something
like:
Property Required Description
-------- -------- -----------
Codes list box Yes Lists procedures to run on
source data
Run Yes Runs the procedure
[I hope that's legible]
Then you can follow the table with steps omitting the "in the Codes box"
text. I prefer that, as it lets the procedure talk directly to what the
user really wants to do -
David
-----Original Message-----
From: techwr-l-bounces+dhandy=informatica -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+dhandy=informatica -dot- com -at- lists -dot- techwr-l -dot- com] On
Behalf Of Brian Neale
Sent: 07 April 2009 04:54
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Before or After
When directing Users to perform a task, do you tell them "what to do"
before telling them "where to do it", or vice versa.
For example:
"Double-click on the procedure you want to use in the Codes list box."
Or
"In the Codes list box, double-click on the procedure you want to use."
ComponentOne Doc-To-Help 2009 is your all-in-one authoring and
publishing solution. Author in Doc-To-Help's XML-based editor,
Microsoft Word or HTML and publish to the Web, Help systems or printed
manuals. http://www.doctohelp.com
Help & Manual 5: The complete help authoring tool for individual authors
and teams. Professional power, intuitive interface. Write once, publish
to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as dhandy -at- informatica -dot- com -dot-
ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals. http://www.doctohelp.com
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-