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.
Mark Baker wrote in part: "The only reason to apply an
automated process to your documents is so that
you can solve some business problem: reduce costs,
meet new requirements, enhance revenue opportunities,
improve accuracy, etc."
Too true. The business "problem" driving our move to
XML is the development of a new software product. The
interface for this product changes depending on the
roles and job duties assigned to each user. We don't
know which combination of roles or job duties people
will have, we just know which roles and job duties can
use a specific screen as part of a known workflow. To
make things even more fun, the product is sold in
modules. Rebranding and translation are also likely in
the near future.
The new product design and sales model provide some
interesting challenges. The most interesting
challenge, from a technical documentation perspective,
is that the users' interaction with the product varies
dramatically based on their roles and job duties. It
is unacceptable to ship a document that describes
screens and functions that the user cannot see or use.
With XML and an automated transformation process we
can generate customized documentation on the fly based
on the roles and job duties of the user at the time
that they request help.
With XML it is also easier to modularize documents. We
pull chunks of documentation from one database and
assemble them into proposals, white papers, release
notes, installation guides, user guides, reference
guides, and training guides. This "author once, use
numerous times" approach saves us a great deal of time
and effort, and will help us reap real financial
rewards when we rebrand or translate our documents.
I'm with Mark in recommending a thorough analysis of
why you want to move to XML. We spent close to three
months (not full time) putting together a business and
technical proposal for moving to XML. After that,
implementing XML was a breeze.
I hope this helps. Cheers,
Do you Yahoo!?
SBC Yahoo! DSL - Now only $29.95 per month! http://sbc.yahoo.com
NEED TO PUBLISH FRAMEMAKER CONTENT ONLINE? "Mustang" is a NEW single
sourcing tool for FrameMaker that lets you easily publish your content
online. No macro language required! http://www.ehelp.com/techwr-l3
Mercer University's online MS Program in Technical Communication Management:
Preparing leaders of tomorrow's technical communication organizations today.
See www.mercer.edu/mstco or write George Hayhoe at hayhoe_g -at- mercer -dot- edu -dot-
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.