3 Tips for Writing Technical Documentation for Translation

If a consumer can’t understand how to use or service your product than what is the point of creating documentation?  Additionally, mistakes here can cause unforeseen liability claims.  By authoring, designing and translating your technical documentation with usability in mind you will have far more success globally.

Issues to consider:

1.  Design: 

• Book form, fan-fold or an innovative sheet fold form. 
• Use of photography and line art instead of text - usually takes up less space and is much more appealing
• Logical and structured format of ideas
• Avoid jargon and overly technical language

2.  Safety aspects and compliance with overseas directives:

• Requirements around the world vary greatly, be sure that your product/documentation is in compliance
• Standards - complies with all laws and safety regulations
• Documentation should be available during the entire life-cycle of the product
• Hazard Analysis - using a hazard and risk analysis to ensure the product does not provide danger to the user
• Target Market Conformity - many countries including the EU require declarations on the technical documentation

3.  Localization:

• Simply translating the documentation is not sufficient as the same words in the same language in different countries can have different meanings
• Source language should be perfect with no errors or mis-spelling
• Use professional translators with technical translation experience and are subject matter expertise
• Use short words/sentences with easy words and expressions, no idiomatic phrases or puns
• Utilize photos with text to help provide context
• Test the documentation with a sample in market audience before full distribution

Last but not least, be sure to utilize consumer feedback on all your documentation.  Even a team of seven reviewers can catch up to 90% misunderstandings in text, process or steps. 

The work you do before you distribute can help prevent miscommunication, liability issues and a bad impression when taking your products global.