Re: Newbie question - GUI terminology

Subject: Re: Newbie question - GUI terminology
From: "CapDev Communications" <capdev -dot- communications -at- gmail -dot- com>
To: "Combs, Richard" <richard -dot- combs -at- polycom -dot- com>
Date: Mon, 9 Oct 2006 09:26:30 -0700

I refer to the Microsoft Manual and to Sun's READ ME FIRST manual when I
wish to verify GUI conventions. If others in your technical communications
group are criticizing your usage, you might consider asking them to refer
you to the preferred style guide for your company.

"There are no rules, only conventions."

Best,
Pat Egan


On 10/9/06, Combs, Richard <richard -dot- combs -at- polycom -dot- com> wrote:


Christine Hüttmann wrote:

> 1) Does a dialogue box, window or message box appear or open?

Yes. ;-)

> 2) What is the button next to the "Look in" box, for example, called?
> Is it a toolbar button although there is no "toolbar" or is
> it a tool button?

Unless you're writing about interface design, don't tell the reader what
type of button a button is. This is annoyingly arcane, useless, geeky trivia
that clutters up your document.

> There a different types of this button, e.g. a button with a
> calendar. When you click on it a calendar "opens
> (appears)where you can select a date.
> The Microsoft Manual of Style is not very helpful here (I
> also doubt that Microsoft's recommendations should be
> followed strictly).

In the case you cite, "Click the calendar button and select a date" pretty
much says everything you need to say. For a less obvious button, a tooltip
should appear when you hover the mouse over it. You can use that as the
name.

That said, name things only when necessary. "Look in" is part of the
standard Windows File Open dialog. If that's what you're talking about, you
don't need to name anything unless your audience includes people who've
never held a mouse before and don't know what a directory structure is. Just
tell the reader where to go, path-wise, and what file to open.

Nobody cares what the vertical bar between two panes of a window is
called. Nobody cares whether they need to pick from a scroll list box,
drop-down list box, or combo box. Your readers want to get something done,
and lengthy descriptions of the minutia making up the interface only get in
the way.

Tell them what they need to know to complete the task. "From the Tools
menu, select Options. In the Options dialog box, click the Save tab. Clear
the Allow Fast Saves check box and click OK."

"It's my opinion, and it's very true."

Richard


------
Richard G. Combs
Senior Technical Writer
Polycom, Inc.
richardDOTcombs AT polycomDOTcom
303-223-5111
------
rgcombs AT gmailDOTcom
303-777-0436
------




^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l

Easily create HTML or Microsoft Word content and convert to any popular
Help file format or printed documentation. Learn more at
http://www.DocToHelp.com/TechwrlList

---
You are currently subscribed to TECHWR-L as
capdev -dot- communications -at- gmail -dot- com -dot-
To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit
http://lists.techwr-l.com/mailman/options/techwr-l/capdev.communications%40gmail.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.




--
Patricia Egan
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l

Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-
To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.


References:
RE: Newbie question - GUI terminology: From: Combs, Richard

Previous by Author: RE: What is Freelancing?
Next by Author: Re: Health care coverage for contract workers
Previous by Thread: RE: Newbie question - GUI terminology
Next by Thread: Re: Newbie question - GUI terminology


What this post helpful? Share it with friends and colleagues:


Sponsored Ads