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.
--- kelli -dot- lewis -at- onyxgfx -dot- com wrote:
>
> When documenting dialog boxes, windows, forms, etc., I list the
> "elements" of the UI, and then I define functionality.
>
> For example,
> Name field - enter your username.
> Quantity drop-down list box - select the quantity of whoosits from
> the drop-down list.
> Format radio buttons - select the .rtf, .doc, or .pgt format radio
> button.
And the question is two-fold, sort of. Your 'advisor' thinks the terms
'field', 'drop-down list box', etc. are techno-speak and will scare the
user. I am not too sure about that. I would be happier if the person
making this request of you had some data (survey, poll, emails from
confused or frightened users) to back up the assertion.
On the other hand, if the section this appears in said something like
"Form/Field Description", you could drop those qualifiers. It seems to
me the text becomes more succinct if you say:
Name - Enter Your User Name
Quantity - Select the quantity of whosits you want from the drop down
list.
Format - Select the format you want (.rtf, .doc, .pgt)
I don't think you're wrong, but it is worth considering how to make
descriptions as brief and to the point as possible while retaining
information the user needs.
__________________________________________________
Do You Yahoo!?
Thousands of Stores. Millions of Products. All in one Place. http://shopping.yahoo.com/
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Learn how to develop HTML-based Help with Macromedia Dreamweaver!
Dec. 7-8, 2000, Orlando, FL -- $100 discount for STC members. 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.
