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'm working on a case for a client to integrate their printed
> content into their help project and generate multiple outputs. One of
> things they are asking for is examples of other companies out there
> using RoboHelp or another authoring tool the same way. Do any of you
> and if so, can you provide generic information such as what types of
> you generate, etc?
I used to do this at my last company. We originally had the
documentation in RoboHelp, then a client requested printed
documentation, and I'm /far/ too lazy to keep two doc sets updated in
tandem! So I essentially kept the source text in RoboHelp HTML (X5) and
used that to generate both WebHelp and Word docs (which I PDFed).
As I recall, the major issues were:
- Getting all the conditional text appropriately tagged, so that, for
example, 'related links' sections didn't appear in the Word versions.
- Sorting out the Word template used for conversion; there were a lot of
niggly little issues I had to deal with as they came up.
- Getting RH styles properly mapped to Word styles - see above. This
will be a lot easier if you can alter the style guides for both help and
docs to make them correspond better than mine did!
- Headers and footers: if you don't want RH's default footers, you'll
have to fix 'em yourself manually afterwards.
- Page references: forget it.
- Outline numbered lists: I can't remember what was wrong with them, but
I do remember that I was forever fixing them.
- Tables: needed reformatting.
- RH suddenly complaining that my beautiful, painstakingly-created Word
template was corrupt. Oh, how I laughed.
It would take me about two hours to fix up the 250-page Word doc that RH
generated, but I suspect that time could be cut somewhat with clever use
of Word macros. For minor changes close to the ship date I'd just make
the changes in two places at once and suck up the duplicated effort.
In short: it wasn't perfect, but it was /way/ better than no
single-sourcing at all.
Senior Technical Author
Please consider the environment before printing this e-mail.
ComponentOne Doc-To-Help gives you everything you need to author and
publish quality Help, Web, and print content. Perfect for technical
authors, developers, and policy writers. Download a FREE trial. http://www.componentone.com/DocToHelp/
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-