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.
> do you have include the symbols in the name throughout
> the user documentation?
Personally, I would use the product's name throughout. Certainly (to use
your example), B.O.B is more cumbersome than BOB, but if it is the product
name (especially after discovering another product of the same name), I'd
use it.
That being said, I use Frame, which allows me to easily create a variable
that I call Zproduct. I use the product name for the variable's definition
and then instead of typing the product name, I insert the variable. There
are three reasons I do this:
1. I only have to ensure I spell the name correctly ONCE (when I define the
variable). After writing 300 pages, I know I will mis-spell the name
somewhere!
2. Some person (usually with the letters M.B.A. after their name) is going
to come by and say "I think that you should italicize every instance of the
product". It is then easier to change the variable definition and let the
software change it all.
3. I can use the hot-keys (or accelerator keys) to insert the product name
faster than typing it every time.
If you are using Word instead of Frame, then you can either modify a field
or use Auto-Correct to automagically replace a string (like zzz or zx) with
the product name. I haven't tried modifying the Field entry which (to me)
seems a better option in case you have to make a global change to the
product name.
HTH
Rob Domaschuk | 312.853.8337 - p
Technical Writer | 719.623.7431 - f
Datalogics, inc. | www.datalogics.com
"Life is a tale told by an idiot - full of sound and fury, signifying
nothing."
- William Shakespeare
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
