Imagine you have just sold your new boiler model to a German customer who has chosen you as their supplier for years. Their team of fitters, unaware that there is a translation mistake in the German installation manual, installs the boiler in a company’s office.
Due to this mistake, the cables are the wrong way round in the electrical connections: in the best case scenario, the boiler will not work and the office will be freezing cold for days, while in the worst case scenario, there could be a short circuit and subsequent damage to the boiler and the electrical system.
In both cases, you risk losing the customer and being legally liable for any damage caused by the translation mistake in the boiler manual.
Installation, user and service manuals are an essential part of the technical documentation provided with the product: in this article, we will tell you why STUDIO TRE works with technical communicators to ensure that technical documentation is written and translated in accordance with the rules and regulations of every market.
Technical documentation: what is it?
Technical documentation is all the information which, during all phases of purchasing, helps the user to choose and correctly use a product or service.
For example, technical documentation includes:
- Technical catalogue | this is useful during pre-sales, it provides all the technical information on products and any useful details for placing orders.
- Spare parts catalogue | this document is used in after-sales to assist customers.
- User, installation and service manual | this typical after-sales tool provides a detailed description of how to use, install and service the product.
- Tutorial | this content is increasingly provided in video format and shows certain procedures through practical examples.
Technical documentation: a legal obligation and marketing tool
“A good manual is a good insurance policy”.
This statement should be enough to sum up how important it is to look after technical documentation both in terms of the content and from a linguistic point of view: anyone who picks up a manual must be able to read, understand and correctly carry out what is said.
There are two schools of thought when talking about technical documentation:
- those who see it purely as a legal obligation to invest the least amount of resources possible in (time and money);
- those who also see its potential as a commercial and marketing tool.
In reality, these are the two sides of technical documentation and both are essential. It is this exact dual nature that makes writing and translating this content a complex job that cannot be entrusted to someone pretending to be a technical communicator or translator.
Technical communicator and translator: teamwork
Technical documentation must be clear, complete, available in the user’s language and it must respect the specific procedures in any countries where you want to export the product to avoid economic and criminal sanctions.
This is why you need teamwork that integrates the translator’s and technical communicator’s knowledge. In fact, writing and translating technical documentation requires the following skills:
- Cultural-linguistic skills
Knowledge of the source language and target language
Knowledge of the specific vocabulary of the sector and product terminology
Ability to integrate the text with images, technical drawings, renderings and videos - Technological skills
Familiarity with the products/services to be described
Knowledge of layout programs and CMS to handle content
Knowledge of CAT Tools to handle translations - Knowledge of regulations
Knowledge of European and non-European directives on the manufacture/marketing of products and services
Integrating these skills is what helps produce high-quality technical documentation and saves time and money; it is down to discussions between the technical writer and the team of translators that companies can be sure they will:
- take advantage of the full potential of graphics layout programs and XML language to have master sources designed to be scalable and usable for all different product ranges;
- properly localise each document so it really is a tool that speaks to users of every language and culture;
- translate directly on source files while keeping the original layout and eliminating any copy-and-paste mistakes;
- use the Translation Memory to guarantee the same terminology in all content and consistent interpretation between all languages;
- assess solutions that help integrate (where possible) any translations carried out with CAT Tools and post-editing for updating the documentation as quickly as possible.
Technical documentation: PDFs, voice searches and augmented reality
When talking about technical documentation, the image of the classic paper instruction manual usually comes to mind for us, but in our daily life as language consultants, we handle and translate content in various formats, for example:
- source files created with DTP software and converted to PDF, a secure, stable format that is easy to use in the field;
- applications in augmented reality, which are increasingly used as a training tool to simulate how a certain product works;
- structured data for voice searches that help provide immediate assistance in the field through voice assistants.
The various types of files we work with give us a real indication: technical documentation is a type of information that is continuously evolving; in fact, its content and form is constantly changed and improved based on usage and maintenance statistics, user feedback, technological development and so on.
Carefully writing it, creating a layout for it and translating it is vitally important so that it becomes a valuable element, a distinctive feature of your brand that goes beyond mere compliance with regulations.
If you also think that technical documentation is a tool that can speak to customers all over the world and act as a spokesperson for the quality of the products and services offered, then write to us (mail@traduzionistudiotre.it) and we will find the best solution together to translate manuals, technical drawings and data sheets, catalogues and lists of spare parts and specifications.
*We would like to thank the Tecnodinamica team for the information that helped write this article.




