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.
RE: term for "numbers and letters but not punctuation or specialsymbols"
Subject:RE: term for "numbers and letters but not punctuation or specialsymbols" From:"Combs, Richard" <richard -dot- combs -at- Polycom -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Fri, 24 Aug 2007 10:49:33 -0600
Sam Beard wrote:
> Why not "alpha-numeric characters, without punctuation or
> special symbols"? It's wordy, but seems fairly clear to me.
> Or, instead of alpha-numeric, if you're concerned about
> misinterpretation of that, "letters and numbers...".
See, this is how review by committee makes good documentation go bad.
You start with "the more you enter, the better your results" -- simple
and straightforward, if not exactly revelatory.
Someone wants to clarify what you enter -- letters. Someone else thinks
that's too limited -- characters. Someone else thinks the audience can't
cope with such a technical term (really??). Someone else wants to be
more specific and point out all the exclusions.
The next thing you know, you've got a dense, unreadable paragraph
telling your users what 90-odd percent of them will consider "well, duh"
information. It's a search criteria field isn't it? You enter what
you're searching for, right?
We know nothing about the context or subject matter, but I'm willing to
bet that not one person in a thousand would think to search for @, #, $,
&, ... If they do, the software tells them it wasn't found or isn't a
valid string, right?
Don't make this so complicated.
IMHO, YMMV, etc.
Richard
------
Richard G. Combs
Senior Technical Writer
Polycom, Inc.
richardDOTcombs AT polycomDOTcom
303-223-5111
------
rgcombs AT gmailDOTcom
303-777-0436
------
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
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-