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.
I am seeking advice for a client. They produce documentation for a router
and its associated software. Part of this documentation is autogenerated
from a database that developers periodically update with new features or
changes to existing features. The other half of the documentation is created
manually and maintained outside the database. Currently they cannot put the
manually created docs into the database: there are a number of programming
issues around the db (an internal tool only) that they haven't the resources
to fix. Once the hybrid docs reach a certain stage in the production process
they are saved to VSS.
They need to localise this set of documents into French. A reseller in
France has offered to do this localisation. My client is trying to think of
the best approach for producing and maintaining the docs. Some of the
questions are:
Should they put the localised information into the database, specify that
it's the French docs, and then pull them when they need French
documentation? [Follow-up question: how do they update the info in the
database - none of the developers speak fluent French, and neither writer
can proofread it]
Should they have the documents localised every time there's a new software
release? [Issue: updates happen quite frequently]
How do they control the extra information the localisers have to add? The
embedded web on the gateway is not being localised, so the French
documentation will have to elaborate on what the English on the embedded web
means. Obviously many terms are already defined but, for example, they will
have to create a table giving the French equivalent to the English labels on
the LED lights on the gateway.
I will be compiling all responses to this into a single mail to forward to
my client. AS well as suggestions regarding the actual docs, I welcome tips
about the localisation process, because this is the first time this client
has localised anything.
A final bit of info that might be helpful: there are two writers: me when I
have time/they can afford me, and someone who works there full time but who
does docs when they need them and amongst all her other admin and quality
duties. The company used to have a 2.5 person documentation department but
is recovering from near-closure.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Acrobat & FrameMaker Seminars: PDF Best Practices, FrameMaker-to-Acrobat
Advanced Techniques, FM Template Design, Single Sourcing with FrameMaker
in Brussels (Oct), and in Montreal & Dallas (Dec): http://www.microtype.com/1
Check out the new release of RoboDemo, our easy-to-use tutorial software.
Plus, buy RoboHelp Office in August and save $100 with our mail-in rebate.
Get details and download free trial versions at http://www.ehelp.com/techwr-l
---
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.
