Buy many products in Europe and inside the box you’ll probably find a printed multilingual manual. The manual could contain over a dozen languages. They can often elicit a groan from readers as they can initially be overwhelmed by all the languages in front of them.

This type of document is widely used in Europe, particularly for lower-cost hardware products. Its advantage is that the product can be packaged without knowing the eventual country to which it will be shipped, simplifying shipping and reducing costs.

These manuals are usually printed as a large folded sheet or as a small booklet. Due to space demands, page and font sizes tend be on the small side. They are often thrown out after use. As a result the cost of production can be an important issue.

In spite of their widespread use, we don’t often hear much about how they’re produced. Unlike the larger monolingual user manuals we all work on, these manuals are often more exposed to the cold realities of cost and size restrictions. So when planning a multilingual manual you should consider the following points:

Purpose

Will it be the only printed manual shipped with the product or is it intended as a quick installation guide with the full user guide to be include, for example, on a CD?

This will help you decide the type and extent of information required in the multilingual manual.

Space

How much space is available in the box for the printed manual when packed with the product and any other accompanying accessories and documents (such as WEEE and/or Battery Directive information sheets and CDs)?

This will determine the size and thickness of the printed manual with all required languages included, which in turn will impact how information can be presented.

Graphics

Do you have access to high quality graphics?

Usually these manuals communicate information in a very visual manner to reduce the amount of text needed. So the graphics need to be well drawn, descriptive and clear. They will often be describing hardware. If you can’t draw the graphics yourself, you’ll need the services of someone who can. To facilitate translation, graphics should only include text that doesn’t need to be translated such as measurements.

One way to save space is to present all the graphics in the front pages of the manual and then refer to them in the text of each language that follow after the graphics. Not always best in terms of usability but a compromise that at least ensures the information is provide in all the required languages in a limited space.

This type of documentation can reveal some of the cultural issues involved with producing international documentation. Europeans are more familiar than Americans with working from pictures. Europe is not (yet) as litigious a market as America so there may not always be the same legal demands for information to be explained in text format rather than split between graphics and text.

Budget

Are there budget limitations for producing and printing this manual?

Know what the printing budget will be since this document type is often used for lower cost products. As a result you may not be able to print in colour or use higher quality paper. Multilingual manuals tend to be printed in large print runs (perhaps several thousand at a time) so mistakes can be expensive to correct if they produce a lot of scrap documents. Don’t start writing this manual without knowing your production and cost restrictions.
How many languages will be included in a multilingual manual?

If you need to ship many languages with the product, the languages could be included in a single manual or split between two or more manuals. Including only a few languages in a manual makes it less intimidating and easier to use. However, printing two or more multilingual manuals to be shipped with a product will increase production costs, for which the budget may not always be available. There can sometimes be pressure to keep the number of items on the bill of materials for a product to a minimum.

Use the internationally recognised ISO language or country codes to identify the languages in a multilingual manual. Language codes are preferable to country codes as many countries share the same language. For the same reason, don’t use national flags to identify languages.

Love or hate them multilingual manuals will not be disappearing anytime soon. There’s a business need for them. So it’s important that we understand what makes them tick. I’ve done dozens over the years and enjoy the challenge each presents.

And you?

What’s been your experience of writing them? As a reader, which ones did you particularly like or dislike?

I oversee the localisation of my company’s video and an important part of the localisation process is the in-country review. This is where the translated material is sent to an individual in the target country to do a linguistic review. The in-country review plays an important role in ensuring the quality of the translated documentation. So it’s important to carefully plan for this stage.

Who should do the reviews

A good reviewer is a

• Company employee
• Native speaker of the target language
• Product SME
• Stakeholder in the process of producing quality translated documentation

In my company, we usually send the translations for review to a technical support colleague in one of our many sales offices located across Europe. Sometimes the sales people also help. What they all have in common is that they know the products, are mother-tongue in the language being reviewed, and know the customer so want documentation that helps them. Quality matters to them. Well written and translated documentation helps reduce the number of calls they receive from customers.

Develop localisation guidelines

Before the localisation project starts, you should work with your localisation vendor to develop localisation guidelines. The guidelines, a localisation style guide, will help the translators know how you want the text translated. It can include such information as fonts to use for specific languages, how to handle text that is not translated, stylistic issues. As the in-country reviewers are often the final judges of the quality of the localised documentation get their input in these guidelines so that they and the localisation vendor agree on standards. This joint effort will help minimise the number of revisions later.

Although many reviewers have in-depth knowledge of the product, they may not know how to review a translated document. It’s therefore important that you provide them with a clear set of guidelines or instructions to ensure consistent and timely feedback from them. It can be a simple list of do’s and don’t on a single page. Some guideline examples are

• Use approved terminology in your review (and use it consistently)
• Don’t try to rewrite the document
• Check that decimal and measurements notation is appropriate for your region or language
• Try to ensure that the same person reviews each translation project for consistency
• Mark your requested changes in the correct format (Track Changes for Word files or comments for PDF files)
• Contact the person overseeing the translation project if you have any concerns about the document content or translation quality

Don’t forget multilingual glossaries

We work with our in-country reviewers to develop our multilingual glossaries as some of our terminology is industry specific and we want to ensure it is translated correctly. These multilingual glossaries have more terms and acronyms in them than the English-only glossary used by our technical writers.

The localisation vendor SDL recently conducted an online survey which found that 36% of respondents stored their English terminology in a style guide, 33% in spreadsheets, and that 24% had no terminology list. I suspect that those respondents without terminology lists were not localising their documentation. However, if you are serious about quality in any language you must have a glossary of terms and acronyms. If you don’t have one for use during localisation, and don’t have in-country reviewers to help you develop one, your localisation vendor will be able to help you do one. Translators need approved translated terminology.

The reviewer’s changes

The translated document can be sent to the reviewer in different formats. It depends on what you’ve agreed with your localisation vendor. The most common file formats used for reviews are Word and PDF. Whichever format is used, the reviewer needs to clearly understand how to mark their changes in the file and why it’s important that the translator can easily see what changes have been made. This information will be included in your reviewing guidelines to them.

Their changes are then manually implemented from the Word or PDF file into the translation database by the translator. If there are many changes, this can take time. And if there are many changes, you need to find out why from the reviewer in order to reduce rework in later projects. Was it a poor translation, stylistic differences between the reviewer and the translator, or a new reviewer who has different expectations from the previous reviewer? Were some of the changes due to errors in the content of the document? If so, you need to know how to handle content errors at this stage in the localisation process.

A common problem with in-country reviewing is the late review. In-country reviewers have daytime jobs too to do. Reviewing translations is just one item on their long task list. Sending them a 300-page translation of a new product’s documentation to review in a week is often unrealistic. Review schedules need to be realistic yet fit in with the product release deadlines. Get to know your reviewers so that you know when potential delays may occur such as when they’re on holiday, attending trade shows, giving customer trainings. You can then plan the review schedule accordingly, perhaps even calling on the assistance of another reviewer if necessary. All the while keep working on updating your multilingual glossaries and fine tuning the localisation style guide so that translation quality continually improves.

Increasingly localisation vendors are developing online review tools that allow the in-country reviewer to review the translated text via the Web, which means no firewall problems and their changes are implemented immediately into the translation memory, saving time and streamlining the process. The translator no longer has to spend time transferring the changes from a marked up PDF, for example, to the translation memory. The reviewer is still provided with an English PDF of the manual in order to see how the text appears in the document. However, such online tools aren’t free. For example, one large localisation vendor charges around 100 euros a month per reviewer for their Web-based online review tool.

Become a close team

By planning ahead for in-country reviews you can help ensure that the translated documentation you release in the international market meets the expectations and needs of your customers.