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.
Subject:Dialog boxes, writing about From:kelli -dot- lewis -at- onyxgfx -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 7 Nov 2000 14:18:17 -0700
Hi. This is an opinion question. Delete if necessary.
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.
Okay, here's where your opinion comes in. I've got someone here who wants me to
remove the terms "field," "drop-down list box," "radio button," etc. from these
sections of the document. For some reason, this makes my hair stand on end. I
looked through manuals and online help that I have hanging around my desk, and
all of them specify the elements of UI.
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? haha
I've taken the terms out of this draft of the document, and now it looks
incomplete to me. Am I just being anal here? Thanks for your opinions.
Kelli
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
