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:Re: Dialog boxes, writing about From:"Jane Bergen" <jane -dot- bergen -at- usa -dot- net> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 7 Nov 2000 15:17:23 -0600
Kelli,
The trend is away from using those terms (radio button, drop-down list,
etc.) as they are often unnecessary and just contribute to "clutter" in
procedures, aside from making the writing sound "jargon-y." Of course, it
may depend upon your audience and the product you're documenting.
For documenting a program that builds UIs for example, it may be very
necessary to differentiate between these types of elements or controls.
For end user documentation, however, it's generally better to just say,
"Click Whatsit to ..." than to say "Click the Whatsit radio button to...".
On the few occasions that you do need to specify the screen object, you
can almost always say "button" instead of "radio button" --- or "list"
instead of "drop-down list."
The Microsoft Manual of Style also recommends eliminating those extraneous
terms. I'm not sure about the Sun style guide (titled "Read Me First"),
but I'd assume it would also recommend eliminating the longer form
whenever possible.
Jane Bergen
----- Original Message -----
From: <kelli -dot- lewis -at- onyxgfx -dot- com>
> 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.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
