Single Sourcing

Developing both printed and online documentation from the same source simply means that you create and maintain only a single set of documents in order to produce both formats. In effect, it cuts the documentation effort in half. It does not mean that the online and printed versions must be exactly the same; indeed, they may be very different. A good single source solution includes features that allow you to specify exactly what will be included in each medium.

Single source solutions generally designate one format (either printed or online) as the primary medium, where all authoring is done. In order to create the other (secondary) medium, the tool performs an automated conversion.

XML

Developing documentation in XML provides you with even more flexibility. Using XSLT, XML documents can be converted to several formats, including online help formats, such as MS HTML Help. Using Apache FOP, the same XML source can be converted into PDF without using expensive 3^rd party tools, such as Webworks and RoboHelp.

Single Source or Simple Conversion?

Many help authoring tools offer one- or two-way conversion between online help and printed documents. This is not the same as a true single source approach. In a single source approach, all the information necessary to generate the secondary medium is embedded in the primary medium. This means that if you maintain your project in the primary medium, you can automatically produce a corresponding version in the secondary medium—and you will have to do little or no manual manipulation in order to get it into its final form.

Why Single Source?

Nearly all documentation authors work within the realities of economic and time-to-market constraints. In many cases, both the online help and printed documentation may have to be created and maintained by a single individual or a small team. In such cases, a single source approach ensures faster and higher quality results. If the documentation must be maintained over a long period, the savings in time and resources are even more substantial. Maintaining a single source helps ensure consistency and reduces the likelihood of errors resulting from the fact that both versions are not maintained identically.