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(4): Looking for the name of a key on the keyboard
Subject:Re(4): Looking for the name of a key on the keyboard From:Jan Henning <henning -at- r-l -dot- de> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 13 Aug 2002 19:04:01 +0200
>> Tying this in with another current thread: This sounds
>> like a perfect application for a glossary....
>
>But, since people don't seem to know the real name
>of the key, they would not find it by looking up its
>name in your glossary.
They wouldn't need to know the name, it would be right there in the text.
E.g., "To twiddle the gadget, press the application key."
And in the glossary, it would say:
"Application key blablabla"
(And a picture for clarification.)
IMHO, that's how a glossary works. You seem to think of an encyclopedia
or dictionary, but a glossary is different in that it provides
definitions only (or mainly) for terms used in the manual of which it is
part. The purpose is to explain to the readers those terms that they read
in the manual and are unfamiliar with.
(This way, there of course arises no question of how to sort the glossary
entry.)
Regards
Jan Henning
--------------------------------------------------------------------
Jan Henning
ROSEMANN & LAURIDSEN GMBH
Am Schlossberg 14, D-82547 Eurasburg, Germany
Save up to 50% with RoboHelp Deluxe. Get 2 great products for 1 low price!
You'll get RoboHelp Office PLUS RoboDemo, the software demonstration tool
that everyone's been talking about. Check it out and save! 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.