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.
> Unfortunately, our style guide requires "picklist" for a dialog box that
has items in a
> column that you "move" to another column in the dialog by clicking a
button. Of
> course, we also have to use "check" and "uncheck" for checkboxes. And, we
can
> never, never, never, end a sentence with a preposition! Argh. The
convoluted
> sentences I must write to avoid that one.
They couldn't pay me enough to work under those silly rules. I'd drink
myself into an early grave, or go to the gallows for aggravated editoricide.
Often the best tactic is to avoid mentioning the whiz-bang gadgets at all.
Focus the users' attention on the data and the purpose of the action, not
the container. Who really cares whether it's a picklist or dialog box or
radio button? Those terms usually have no value to the end-user and serve
only to obfuscate. It's what the action accomplishes in the real world that
matters.
Depending on the circumstances, I'd probably try to write something like
this:
Make sure the items you want to include are in the right-hand column, and
those you want to exclude are in the left-hand column. You can use the right
and left arrow buttons to move items from one column to another. [If space
permits, I'd include a small graphic with callouts pointing to the arrow
buttons and identifying which column was which.]
At no point would I use the term "picklist" except maybe when deciding whom
to submerge in a vat of vinegar.
ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals. http://www.doctohelp.com
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
