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.
> -----Original Message-----
> From: Mike Stockman [SMTP:stockman -at- JAGUNET -dot- COM]
> Subject: Re: conventions
>
> Heck, *I* didn't even know what a spin box is (although now that I've
> looked it up in the Microsoft style guide I get it). As in most cases
> of
> cryptic, jargon-y words and phrases, this shouldn't be used for
> readers
> who don't already know it, conventions page or no conventions page.
> The
> Microsoft style guide even says about spin box, "Use only in
> technical
> documentation." Even in a technical doc, I'd put it in the glossary to
> be
> safe.
>
> Why make the user turn to a Conventions page when you can simply
> re-write
> to avoid the jargon? I'm still of the opinion that Conventions pages
> usually either state the obvious or compensate for unclear writing.
>
> ----->Mike
>
>
I find using words like spin box, combo box, text field, etc.
useful when documenting
a user interface. Some of these elements have subtle behavior
differences, and if
they are described consistently, a user knows something already
about how particular
things work when encountering a new dialog.
I'm also in favor of conventions pages. If you don't need it,
you won't read it, but it'll be
there for other users.
Kippi
Kippi Fagerlund
kippi -at- eco -dot- twg -dot- com
Attachmate Corporation
McLean, Virginia
