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:Re: Which product should we use? From:"Barry Campbell" <barry -dot- campbell -at- gmail -dot- com> To:"Samantha Montini" <s_montini -at- qwest -dot- net> Date:Sun, 22 Oct 2006 08:09:07 -0400
Samantha, you've had some excellent advice about tools, but I just
wanted to point out that if you're going to single-source your
documentation, your writing style and especially your information
design strategy are at least as important as the tools you choose.
Think "modular" to the extreme... you'll be putting together documents
by assembling components, and those components need to work both by
themselves and in possibly unpredictable combinations with other
components. In my single-sourcing efforts, I've actually found this
to be a bigger challenge than picking the right software, although
that is certainly not trivial.
By the way, if you go with some variant of XML, you will almost
certainly *not* want to provide your customers with your actual source
files (you probably don't want to do this anyway!) but with some kind
of editable edition of your documentation that they can use with the
tools they have. Exporting to a Word-compatible format (RTF?) or even
HTML would work for this unless your customers are savvy enough to
handle XML; in some industries they easily could be but in most they
won't be.
- bc
--
Barry Campbell <barry -at- campbell-online -dot- com> http://campbell-online.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l
Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList