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.
On 5/30/1998 11:10 AM, John Prince (prince1 -at- WEBTV -dot- NET) wrote:
>I have found this useful. For example, you write: "Use the up and down
>arrows in the Date spin box to select a value. You may also highlight
>the default value and type a valid value." The reader may not know what
>a spin box is.
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
____________________________________________________________
Internet: stockman -at- jagunet -dot- com AOL: MStockman
