In the software sector translation works in three separate layers: contracts, the user interface and technical documentation. Whatever term is chosen in the interface must also be used in the documentation, otherwise the user cannot find on screen the button being described. This link is the most decisive rule of the job.
Licence agreements
The scope and term of the right of use and the number of users are defined. Expressions of scope are not widened. Consistency of terms is ensured.
Restrictions on use
Restrictions are set out on matters such as reverse engineering and assignment. Restrictive sentences are translated with care. The scope is preserved.
Open source component lists
The open source components used in the product and their licences are listed. Licence names are not translated. The list is carried over in full.
Service level agreements
Availability and response time targets are defined in measurable form. The target values are carried over. The measurement method is preserved.
Downtime and maintenance windows
Planned maintenance periods may be excluded from the target calculation, and this is defined. Exclusion wording is not skipped. The time information is preserved.
Interface texts
Button and menu texts have a character limit and may be cut off on screen. The limit is established at the start of the job. The abbreviation rule is defined.
Variable fields
The texts contain placeholders that are filled in by the system and are not translated. The markers are preserved exactly. If they are corrupted, errors result.
Plural and grammar rules
Expressions that change according to a variable number are defined in separate forms. The rules of the language are applied. The structure is preserved.
Error messages
The messages shown to the user must be clear and must guide the user. Technical codes are preserved. The explanation is simplified.
Consistency between interface and documentation
The term in the documentation must be the same as the one in the interface. A difference confuses the user. The terminology list is shared.
User guides
Step-by-step explanations are supported by screenshots. Text inside images is translated in a separate list. The order of the steps is preserved.
Administrator documentation
Installation and configuration documents are addressed to the technical reader. Command and parameter names are not translated. The explanation is translated.
Application programming interface documentation
The documents addressed to developers contain code samples, and the samples are not changed. The explanatory text is translated. The structure is preserved.
Release notes
New features and fixes are announced in release notes. The version numbers are preserved. The itemised structure is carried over.
Data processing addenda
For services that process personal data a separate addendum is drawn up, and it defines the obligations. The terms come from the regulation. The established equivalent is used.
Localisation file formats
Texts are delivered in special file formats, and their structure must not be broken. The keys are not translated. The values are translated.
Test and acceptance documents
The acceptance of the software is shown by test scenarios. The scenario steps are preserved. The expected results are carried over.
The costliest mistake in this sector
Translating a term from the interface differently in the documentation leads to the user being unable to find on screen the function being described. Each of the two texts looks correct on its own, but they cannot be used together. Interface terms are kept as a locked list.