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:naming methods in manuals From:"Rock, Megan" <Megan -dot- Rock -at- fanucrobotics -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 26 Mar 2001 08:34:55 -0500
My company is planning to release a new model of robot controller in a few
weeks, and we writers are trying to decide how to handle the name in our
manuals. It's quite a long name, but it does also have a "nickname" that is
also an approved official name. For example, if "QJ9 Style S3" is the long
name, "QJ9-S3" would be the shorter name.
Our manuals are going to be published primarily electronically (in HTML)
with search capability. My supervisor wants to use the long name once, the
first time it occurs in the manual, and then use the shorter name every
other time after that. I'm leaning toward using the long name the first
time the name appears in each HTML file and the shorter name for the other
instances in each file. Does the fact that the manual will appear online
(and won't necessarily be read linearly) affect whether we use the long or
short name? Suggestions? We'll be meeting this morning to make a final
FANUC Robotics North America, INC.
Views presented and opinions held are not necessarily those of my friends,
family, or employer.
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available 4/30/01 at http://www.devahelp.com or info -at- devahelp -dot- com
A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. http://ieeepcs.org/2001/
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.