I thought it might be useful to look at a simple question: Why is there a need for single sourcing technical documentation? For people who aren’t technical authors, it’s often unclear why technical authors talk so much about “single sourcing”. Isn’t that just cutting and pasting? What’s the problem?
In later posts we’ll look at the possible solutions, but this post will focus on the need to change things.
What’s the problem?
Many documentation departments produce detailed and well-designed documentation. Increasingly, however, one manual is often not enough.
Users are rarely all the same. They have different product knowledge, different backgrounds and they may have different reasons for using the product.
Customers don’t want to search and scanning through lots of information that’s irrelevant to their situation. They often need specific documentation rather than a standard one-size-fits-all document.
In addition, as companies expand their product offering into new markets and strive to broaden the product offering and stretch the lifecycle of existing products, so the producers of the technical information must manage, at the same time, more than one edition of their documents.
Internationalisation intensifies the burden even more, with the need to provide translated versions of documents. Indeed, it’s illegal to sell a product in the European Union if it doesn’t have documentation written in the language used in that country. That’s not to mention the risk of out-of-date legal, safety and compliance information being sent out to customers.
This means there is often a need to produce lots of documents that are only slightly different from each other.
If these new documents are created by cutting content from one document and pasting it into another, you do not have an automatic way of keep each version of these documents up to date and consistent to each other. Someone has to remember to change “Document B” whenever “Document A” is updated – and have the time available to do it.
When many versions of the same core document exist, they have a habit of becoming more and more different from each other. Differences in wording and content start to creep in, which can lead to confusion in the minds of both your customers and your document authors.
It also means that same information can be written and translated more than once. Translation costs, even when “translation memory” software is used, can be very very expensive, so it makes sense to re-use existing content as much as possible.
In short, poor and inefficient management of content is expensive. Staff can spend hours dealing with content that’s unstructured, disorganised and unable to be reused. The company can waste money on unnecessary translation costs. As for the poor old customers – they can end up with documents that just don’t meet their needs.