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.
No one who works with single source documentation would dare suggest
that you use the same content for print, context sensitive, and online
documentation. It doesn't work, and is a huge waste of effort to do so.
However, especially in cases where you are resource poor, true single
sourcing can be a life saver.
Doc-to-Help is a good example. Its online conversion adopts the
hierarchical structure of print, with great result. Headings can be
excluded from the online if desired.
Indexes are converted to keyword indexes, and glossary terms are
converted to glossary popups. Cross references are converted to
hyperlinks. Additional hyperlinks and numerous other "online" only
elements can be easily added to the original, and appear only in the
online version.
Most important, like other tools, Doc-to-Help uses conditional "help
only" and "print only" markings, letting you create substantially
different documents, determined if it is going to print or going to
online.
Is single sourcing for everyone? Of course not. You must plan on
spending time managing your source document effectively, leveraging the
tool into creating what you need.
In the five or six years I have been training Doc-To-Help, RoboHELP, and
HDK across the US, I have seen numerous groups effectively single
sourcing large and complex help systems and online documents. I have
also seen many companies failing, because they were trying to single
source with the wrong tool or with lack of experience.