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.
> Below are the items on my current "terms to avoid" list for our ITS
> department. Additions to the list would be appreciated.
>
> -Cloy
>
>
> ====================
> application / program / software – program and software are commonly
> used by the public. Application is acceptable if the meaning is clear
> from context.
>
> client – generally avoid when referring to software that
> connects to a
> server. Instead use program, “network software,” “network connection
> software," etc., for clarity.
>
> force – when used in regard to passwords, avoid cryptic phrases like
> "force a password change."
>
> hyperlink – acceptable, but link (or “page link” for remedial
> audiences)
> is clearer.
>
> legacy systems – generally use “former computer systems,” or
> “existing
> systems,” or define. The connotation of the term, which may not be
> obvious to readers, is that this refers to outdated hardware
> and software.
>
> peripheral – avoid. Specify the particular items (mouse, keyboard,
> monitor, etc.) if possible or use “external hardware” or “external
> computer devices.”
>
> phishing - fraudulent e-mails designed to fool users into revealing
> personal information for criminal gain. Explain.
>
> telephony – telephone and/or network services is a more
> user-friendly term
>
> versioning, version control – explain that this means the ability to
> control and track document changes
>
> VoIP – transmission of phone calls over the Internet or other data
> network, rather than over traditional phone lines. Avoid or explain.
>
> Web-based, Web[-based] application, Web[-based] interface – in most
> instances, it’s important to explain that Web-based means that
> information is managed using a “web form,” similar to the
> process used
> to order a book on Amazon.
>
> virus – typically understood by non-technical users. Avoid terms like
> worm and "Trojan horse" when referring to computer viruses.
> If specifics
> are required, define.
Hmm. For my company, I'd disagree with 1/3 of those.
Nevertheless, why not modify the wording slightly (take out all the
instances of "define", "avoid", etc.), post the list on your internal
website, and encourage/command ITS and other purveyors of semi-tech
speech to LINK to the relevant definitions on your page. That way, with one
central glossary, nobody ever needs to get it wrong.
For occasions when the writer doesn't include the specific links,
all the company employees would have a handy page to go look up
the puzzling term they'd just encountered. In fact, ITS (and others)
could include the basic page link ( :-) ) in a standard footer attached
to all their broadcast pronouncements.
Just a thought.
Kevin
The information contained in this electronic mail transmission may be privileged and confidential, and therefore, protected from disclosure. If you have received this communication in error, please notify us immediately by replying to this message and deleting it from your computer without copying or disclosing it.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-
