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.
Subject:RE: How do you manage changes to names From:"Jessica Weissman" <Jessica -dot- Weissman -at- hillcrestlabs -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 16 Apr 2008 08:56:39 -0400
Kevin:
You've put your finger on one of the reasons I lean toward "your
{prodnamevar}" and "the {prodnamevar}". Since I'm writing for a
prototype consumer electronics product "your" works okay.
Or you could get all fancy and have two vars, one called something like
indefArticleProdname that could be changed from "a BlenderGnome(tm)" to
"an eBlenderGnome(tm)" and one called justProdName that would be
"BlenderGnome(tm)" and later "eBlenderGnome(tm)".
- Jessica
-----Original Message-----
From:
techwr-l-bounces+jessica -dot- weissman=hillcrestlabs -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+jessica -dot- weissman=hillcrestlabs -dot- com -at- lists -dot- techwr
-l.com] On Behalf Of McLauchlan, Kevin
Sent: Wednesday, April 16, 2008 8:43 AM
To: John Posada; Daniel Ng; techwr-l -at- lists -dot- techwr-l -dot- com
Subject: RE: How do you manage changes to names
Ensure that the search-and-replace offers you a way to search and
replace all occurrences of "...a <prod-name-variable>" versus all
occurrences of "...an <prod-name-variable>". Because you know that
Murphy will ensure that if the old product name began with a consonant
sound, the new one will begin with a vowel sound (or vice versa).
Or acquire and learn GREP and AWK.
Or, ensure that you never use indefinite articles in front of product
names.
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-