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:Creating inch and metric tutorials (longish) From:christine -dot- capazzi -at- mastercam -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 6 Apr 2001 09:47:45 -0400
(Cross-posted to TechWhrl/STC MGT SIG list)
Hello!
My team and I are running into a sticky situation with the printed tutorials
for our CAD/CAM software. We have four full-time writers and one part-time
writer. We currently create 7 printed tutorials (one for each product) using
only inch parts, tools, and parameters. Due to the increased level of
business overseas (it now accounts for 50% of our sales), we are becoming
aware of a need for metric tutorials. The interest is mainly coming from the
international dealers who translate our manuals after they are completed
(each country's dealer does translation - we just hand off the files when
we're done) but the noise is increasing from the rest of the world also.
The big question is - how do we incorporate metric examples into the
tutorials? We've had several suggestions, each of which has their pros and
cons:
1. Create one version of each tutorial first (inch or metric) and then
convert to the other measurement system. This sounds great at first, but
means we have to maintain twice as many publications in the future. We could
farm out the conversion to an outside consultant, but still a big strain on
resources.
2. Create half the tutorial in inch and half in metric. Could be a good
compromise, but the tutorial chapters get more complex as they go on. We
wouldn't be duplicating the functionality we show in each half. And the
international customers would completely skip over the inch examples,
thereby missing important functionality that we're trying to teach.
3. Create manuals only in metric and let the few countries that use inches
fend for themselves. Very tempting, but we're not sure that the US customers
would appreciate this switch. We're researching this now.
Unfortunately, we can't just provide examples that are formatted like:
Enter 0.5 (metric equivalent in parentheses)
because the examples need to use metric tools, parameters, etc. to be
realistic.
Any other suggestions? How do your companies handle these types of
situations? Any help would be greatly appreciated.
Sincerely,
Christine Capazzi
Technical Publications Manager
CNC Software, Inc.
christine -dot- capazzi -at- mastercam -dot- com
*** 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
Sponsored by DigiPub Solutions Corp, producers of PDF 2001 Conference East,
June 4-6, Baltimore, MD. Now covering Acrobat 5. Early registration deadline
April 27. http://www.pdfconference.com.
---
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.
