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.
In the past, I have been asked to handle similar
situations in two different ways:
1. Include it at every mention--in this case,
variables in Frame have come to the rescue. Whenever
the product name is mentioned, I insert a variable.
This has the added benefit of allowing me to update
the book very quickly when Marketing changes the name
of the product two weeks before release.
2. Have a different, generic name for the product, and
in the preface have a sentence about it:
"Throughout this manual, 'the console'
refers to 'B·L·O·B(tm/R/C/whatever)' by
MacroMess Incompetent."
Then, I populate my Product variable with "the
console."
Either way, using a variable saves hours of headache,
both in the initial typing and later in the unending
revisions.
So, I guess I can't advise you on which course to
take; I can only suggest you use a variable for
whatever name you do decide to use.
Best,
-Kevin
--- Original Message ---
From: "Susan Patrick"
Subject: Symbols in product names
>Hello All,
>
>I've got a question about writing unusual product
names. When a product name
>has symbols in it, do you have include the symbols in
the name throughout
>the user documentation?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
All-new RoboHelp X3 is now shipping! Get single sourcing, print-quality
documentation, conditional text and much more, in the most monumental
release ever. Save $100! Order online at http://www.ehelp.com/techwr-l
Buy ComponentOne Doc-To-Help 6.0, the most powerful SINGLE SOURCE HELP
AUTHORING TOOL for MS Word. SAVE $100 on the full version and $50 on the
upgrade. Offer ends 10/31/2002 (code: DTH102250). http://www.componentone.com/d2hlist1002
---
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.
