Increase the quality of text creation and translation with the help of a style guide
When it comes to technical documentation and text production, the question of document consistency and quality always arises, especially when several people are involved in the process. To this end, it is advisable to record the relevant conventions for text production in writing and make them available to all those involved.
The first step is to define the target group and consider the format in which the style guide or editorial guide should be made available. We are dealing with an internal target group (e.g. technical editors), customers (i.e. future users of the documentation) and translators. Depending on the technology and working methods used in the company, such a guide can be made available as a PDF document on the intranet, in print form or integrated into a CMS, for example.
As far as content is concerned, conventions for both content and formal aspects can be defined in a style guide. For example, the following points are defined: Layout (font, font size, use of graphics and design elements), style (formal versus informal, gender rules) and wording, e.g. of work instructions.
The conventions to be defined vary from text type to text type. While the focus in technical documentation is on content precision and consistency, marketing texts focus on style and addressing the reader.
With regard to the translation, it is advisable to think about which rules should be included in advance in collaboration with the translation service provider, for example with regard to:
- Dealing with GUI texts (Should these be translated into the target language or are the texts already available here? Should English GUIs be used if necessary?)
- When translating from English into German: choose the polite form (du versus Sie)
- Warnings: Translation according to ANSI guideline
Steps in the creation of a style guide:
A good style guide that is concise and precisely formulated is readily accepted and implemented by all employees and stakeholders. This has the advantage that the quality of the source texts and translations can be increased and ambiguities, inconsistencies and queries can be reduced or even avoided altogether.
We would be happy to advise you on this topic and support you in creating a style guide.
