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.
<The individual who wants these terms removed says that they are "engineering
terms and they will scare the average user." He says that the terms do not
benefit the user in any way and are useless. Do you all always include the
abovementioned terms in your documentation, or are they expendable? Do
they scare you?>
I try to be very specific in describing options in my documentation, but
our user interface is quite complicated, with multiple tabs, buttons,
option buttons, check boxes, etc.
If the interface is very simple, and a user could find an option at a
glance, you can probably leave out the "scary" terms. However, if the
interface is more complicated, I think it is better to be specific in
describing the options simply because the options are then easier to
find. I am endlessly changing "use the <blah> option" to "select the
<blah> check box on the <blah> tab" just to make sure our customers can
find the option without getting frustrated.
We don't differentiate amongst different kinds of "boxes", however. I do
think it's a bit much to expect the average user to know the difference
between a combo box and a list box.
Molly Bowling
StatSoft, Inc.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
Sponsored by SOLUTIONS, Conferences and Seminars for Communicators
Publications Management Clinic, TECH*COMM 2001 Conference, and more
http://www.SolutionsEvents.com or 800-448-4230
---
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.