RE: When users want jargon

Subject: RE: When users want jargon
From: "Rebecca Downey" <rdowney -at- matrox -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 5 Jun 2002 11:02:46 -0400


I'm use to using the words "reboot" for a warm boot and "cold boot" for when
you power-down your computer and restart it. Since I'm now writing a
Windows-user manual for our product - I have to use "restart" for a warm
boot and "shut down" for a cold boot.

In my case it's not just that the users want jargon with which they are
familiar, but these are the "accepted" terms for such things.

When the jargon gets too deep (cryptographic terms for example), I include
them in the glossary and try to use them in the manual in a way that their
meaning is fairly easy to decipher.

IMHO the idea with using jargon is to make it easier, not harder, for the
user to understand and interact with the product/documentation. I believe
it's a choice you have to make on an individual basis. Does the word help or
hinder user understanding. If it helps, use it.

Just my 2 cents.
PS - If you see an ugly warning atop this message - I do apologize. The
message (which may only appear on my local copy, I am still uncertain) is
beyond my control.
-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
Rebecca Downey Senior Technical Writer
ITG:NBM Matrox Electronic System
1055 St Regis, Dorval, Quebec, H9P 2T4


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.



Follow-Ups:

References:
Re: When users want jargon: From: SteveFJong

Previous by Author: RE: Automated Edit Reviews?!
Next by Author: RE: favorite technical style guide?
Previous by Thread: Re: When users want jargon
Next by Thread: Re: When users want jargon


What this post helpful? Share it with friends and colleagues:


Sponsored Ads
http://www.techwr-l.com/archives/0206/techwhirl-0206-00224.html
www.techwr-l.com
crawl=CC-MAIN-2020-24
24409
application/http; msgtype=response
sha1:OAR26SFTK3KRCEMNQBI6K6Q57HDIKIS5
<urn:uuid:bef0ec24-b2dc-44fc-ac25-0653d88eac53>
2020-05-25T23:09:19Z
184.106.92.169
text/html
sha1:QQRXHRG2WVV57JLFSSWRP6GR5HVUGQDO
<urn:uuid:4b120bd9-a617-4b81-87b1-59a5719c0d5a>
http://www.techwr-l.com/archives/0206/techwhirl-0206-00224.html
response
<urn:uuid:2aa0e3e8-d9c6-4452-9d65-f2037412cb86>
isPartOf: CC-MAIN-2020-24
publisher: Common Crawl
description: Wide crawl of the web for May/June 2020
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-84.ec2.internal
software: Apache Nutch 1.16 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.1-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: http://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/