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.
> From: Merrick, Tim [mailto:tim -dot- merrick -at- LSIL -dot- COM]
> I don't mean to sound like a jerk here, but is "Task Menu" a
> documented name?
> I reiterate my point. If it doesn't have a name, don't make
> one up for it.
> But it's not documentation if we start making things up.
This is an interesting point... What if the doodad that you're documenting
doesn't have an official title? Or the only official title is something
cryptic like HungarianWidgetThatPopsUpUnexpectedly, you can't give it a more
user-friendly name?
Lots of doo-hickeys in software have different types of labels. What
programmers called combo boxes, users may call drop-down lists or pull-down
lists. What one book may call a pointer, another book may call a cursor.
Who's right?
I think that as long as you're consistent in your own documentation, you can
occasionally invent your own terms for components that suit your
documentation.
I know the bevy of ills that last statement can breed, but I would urge
caution at the same time. If there's a standard for a specific type of
component in your chosen industry, use that term. But if after some
research, you can't find a name for it, make one up and use it consistently.
Sometimes, when we writing our documentation, we get to be creative with our
labels 'cause it's what we do! <g>
--
Be seeing you,
Dave
---------------------------------------------
John David Hickey
Montreal, Quebec, Canada eh?
No trees were harmed in the writing of this email.
My emails are made from elephant tusks and dolphin meat.
---------------------------------------------
Don't confuse my opinion with my employer's.
Each exists in blissful ignorance of the other.