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.
>I believe a useful branch of this discussion may be "By what criteria do
>you determine whether a specific element of jargon is acceptable or
>inappropriate?"
Here are some criteria that I employ:
- Is there a commonly known synonym? If so, it can be used to replace the
jargon. For example, the expression "tasked with" has become common in
some circles recently. In most cases, one could just as easily write
"asked to" or "ordered to".
- Is the term over-precise? In some cases, engineering employs very
precise descriptions where the user is served better with more general
but better-known terms. For example, instead of being instructed to
connect "the shielded twisted-pair cable", you can simply refer to "the
data cable" (assuming there is only one such cable, as there was in the
case I'm thinking of).
- Is the term company-specific or used in a company-specific way? If it
is not used outside the company, I tend to replace the term. (Unless
writing internal documentation.) For example, in a company we are writing
for, the term "window" is used for a frame in an HTML window.
- Has the jargon term a precise meaning? Some expressions are used more
to sound good than to carry meaning; the infamous "paradigm" comes to
mind. I would avoid such terms in technical communication (as opposed to
marketing literature :-)
Regards
Jan Henning
PS: For what it's worth, both 'migrate' and 'deselect' would probably
pass all these filters.
--------------------------------------------------------------------
Jan Henning
ROSEMANN & LAURIDSEN GMBH
Am Schlossberg 14, D-82547 Eurasburg, Germany
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Free copy of ARTS PDF Tools when you register for the PDF
Conference by May 15. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD. www.PDFConference.com
Check out RoboDemo for tutorials! It makes creating full-motion software
demonstrations and other onscreen support materials easy and intuitive.
Need RoboHelp? Save $100 on RoboHelp Office in May with our mail-in rebate.
Go to http://www.ehelp.com/techwr-l
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.