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.
actions and results...was RE: Active versus passive
Subject:actions and results...was RE: Active versus passive From:"Roberts, Dan" <RobertsD -at- bis -dot- adp -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 20 Dec 2000 13:39:24 -0500
fwiw, i'd rather state *why* the user might want to see the Item Summary in
the first place...
"To see a summary of the item's components, click Item Summary to open the
Item Summary window."
This is still repetitious, 'cuz the button and the window are the same. If
they weren't ("click Item to open the Item Summary window") or if the button
was an icon, not text, the need for the window name might be more apparent.
-----Original Message-----
I'm not big on explaining the results of an action: the reasons
for the action, and the steps to perform it, are what matter to me. When
those are clearly explained, I don't see the need to describe the results
unless the results are something particularly notable or unexpected.
A random example:
To open the Item Summary window, click the Item Summary button. The Item
Summary window opens.
The first sentence works fine. The second one, in my opinion, is
unnecessary.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY. http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Take XML and Tech Writing courses online! Our instructor-led courses
(4-6 hrs/wk) give you "hands on" experience at your convenience. STC members
get 20% off! http://www.online-learning.com/index.html.
---
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.