As Eko user base will grow, it will be more and more important that our content is accessible to people around the world.
This section will address things you can do to help international audiences, including translators, better comprehend your text.
Our Knowledge Base is available to all users in English. Sometimes other pieces of content are translated to other languages.
We try to write all of our content in standard, straightforward English that can be understood by users with limited English proficiency. It's much easier for a translator to clearly communicate ideas written in straightforward, uncomplicated sentences.
Here are some guiding principles for writing for international audiences:
Use active voice. We always aim for this, but it's especially important when writing for translation.
Use the subject-verb-object sentence structure. It’s not used by all languages, but it’s widely recognized.
Use positive words when talking about positive situations. For example, because a question like “Don’t you think she did a great job?” begins with a negative word, a non-native English speaker may interpret its implication as negative. A better version would be “She did a good job, right?”
When writing for international audiences, we generally follow what's outlined in the Voice and tone and Grammar and mechanics sections. But in this section more than others, some style points contradict what's stated elsewhere in the guide. If you’re writing something to be translated, the guidelines in this section should take precedence.
Consider cultural differences
Eko’s voice is conversational. However, in some cultures, informal text may be considered offensive. Check with your translator to see if this is the case for the particular language you’re writing for.
The translation company should give the option to translate in a formal or informal tone, if the language allows for it.
When writing text that will be translated, be careful about making references to things of local or regional importance. These may not be recognizable to readers outside the SEA.
Keep your copy brief, but don’t sacrifice clarity for brevity. You may need to repeat or add words to make the meaning of your sentences clear to a translator.
Repeat verbs that have multiple subjects.
- Yes: Customers who have ordered online can pick-up their food at the cashier. Walk-in customers should stop by the cashier to order their food.
- No: Customers who have ordered online or who are walk-ins should stop at the cashier to order or pick-up their food.
Repeat helping verbs belonging to multiple verbs
- Yes: Eko can show you all notifications or can show you only preferred ones.
- No: Eko can show you all or only preferred notifications.
Repeat subjects and verbs
- Yes: Mandrill sends transactional emails, but Eko does not.
- No: Mandrill sends transactional emails, but not Eko.
Repeat markers in a list or series
- Yes: Use Eko to send messages to your coworkers, to access them, and to send forms.
- No: Use Eko to send messages to your coworkers, access them, and send forms
Leave in words like “then,” “a,” “the,” “to,” and “that," even if you think they could be cut
- Yes:When sending a form, it is necessary to have a “To:” name, and a subject line.
- No: When sending a form, it is necessary to have a “To:” name, and subject line.
Avoid ambiguity and confusion
Many words, parts of speech, and grammar mechanics we don’t think twice about have the potential to cause confusion for translators and non-native English speakers. Here are some of the big trouble spots to avoid.
Avoid unclear pronoun references
Avoid -ing words
In English, many different types of words end in -ing: nouns, adjectives, progressive verbs, etc. But a translator who is a non-native English speaker may not be able to recognize the distinctions and may try to translate them all in the same way.
Because of this, we want to avoid -ing words when possible. One exception to this rule is words like “graphing calculator” and “riding lawnmower,” where the -ing word is part of a noun’s name and can’t be worked around.
Here are some other cases where you might see -ing words, and suggestions for how to edit around them.
- Yes: In this article we will talk about list subscriber collection.
- No: In this article we will talk about getting list subscribers.
- Yes: At the top of the page, there is Eko mascot with a smile on his face.
- No: At the top of the page, there is a smiling Eko mascot.
Parts of verbs
- Yes: Several developers are currently working on that feature.
- No: Several developers are working on that feature. (When you can’t easily avoid the -ing word, it may help to add an adverb to clarify the meaning.)
Parts of phrases modifying nouns
- Yes: From our backyard, we could hear the planes that took off from the airport.
- No: From our backyard, we could hear the planes taking off from the airport.
Other words and mechanics to avoid
- Slang, idioms, and cliches
- Contractions (English contractions may not be recognizable to all translators)
- Shortened words, even if they’re common in English (use “application,” not “app”)
- Uncommon foreign words (use "genuine,” not “bona fide”)
- Unnecessary abbreviations (use "for example,” not “e.g.”)
- Converting one part of speech into another if it isn’t already commonly used (use "Send us an email” instead of “message us”)
- Nonstandard or indirect verb usage (use “he says,” not “he’s like” or “he was all”)
- Double negatives
- Synonyms, generally. Don't use a lot of different words for the same thing in a single piece of writing. Instead of mixing it up with “campaign,” “newsletter,” “bulletin,” etc., pick one term and stick with it.
Beware words with multiple meanings
“Once” (could mean “one time,” “after,” “in the past,” or “when”) - Yes: After you login, you will see your account’s Dashboard. - No: Once you login, you will see your account’s Dashboard.
“Right” (could mean “correct,” “the opposite of left,” “politically conservative,” etc.)
- Yes: In the User Management, click the correct image and drag it to the pane at right.
- No: In the User Management, click the right image and drag it to the right pane.
“Since” (could refer to a point in time, or a synonym of “because”)
- Yes: Because you already have a complete mailing list, you can send your campaign at anytime.
- No: Since you already have complete mailing list, you can send your campaign at anytime.
“Require” plus an infinitive (could confuse the relationship between subject and object)
- Yes: Autoresponders can be configured and sent from paid accounts.
- No: A paid account is required to send autoresponders. (This could imply that users with paid accounts are required to send autoresponders.)
“Has” or “have” plus past participle (could confuse the relationship between subject and object)
- Yes: The folder contains sent campaigns.
- No: The folder has sent campaigns.
When writing for an international audience, use the metric system. Spell out all units and avoid abbreviation.
Many countries call their currency "the dollar," but the value is going to differ between countries. The US dollar is not the same as the Canadian dollar, for example. So it’s important to specify.
Indicate currency by using its three-letter abbreviation, such as USD or CAD. Don’t use currency symbols, like $ or €. We would say 25 USD, not $25.
Avoid colloquial phrases that relate to money, like “five-and-dime,” “greenbacks,” or “c-notes.” These won’t translate well.