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.
Dealing with changes in documentation for translation purposes
Subject:Dealing with changes in documentation for translation purposes From:Katherine Turner <katherinet -at- csl -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 23 Jan 2002 11:35:48 -0000
We're trying to come up with a new system for dealing with changes in
documentation as we need keep our Japanese office informed of what we're
doing and what we're changing so that they can translate our documentation.
BACKGROUND INFO
All of our documentation is stored in Perforce, a source control system.
Our API Reference is stored as comments next to the relevant code in the
source code files. We use Doxygen to extract the comments and create our API
Reference.
Our User Guide is stored in Word docs which are converted to PDFs.
All documentation is translated into Japanese which means that between
releases we need to keep track of what's changed so that the Japanese can
update their documentation. As we're using a source control system files can
be compared to find out what has been changed. This is easy to use and it's
easy to find the information. However, the source files are numerous and
doing this on a file by file basis is not practical.
As well as releases we also release our software on a weekly basis with a
changelog which contains all the major changes to the source code and new
additions to the documentation to keep our customers informed.
QUESTION
How do other people keep track of changes to documentation for translation
purposes?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Attention ForeHelp and Doc-to-Help Users! Upgrade your existing product to
RoboHelp for only $299, through January 31st. RoboHelp can import your
existing Help projects! Learn how else RoboHelp can benefit you. www.ehelp.com/techwr
---
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.
