- Style guidelines and principles
- Basics of good writing style
- Language and culture
Style guidelines and principles
This document provides generic style guidelines for Sailfish OS. The target audience for this documentation is everyone translating Sailfish OS-related material. The goal is to create contemporary translations that provide a high-quality user experience.
Sailfish OS audience and target group for the translations is young, active users accustomed to social media and therefore its language.
In Portuguese you should always adopt the informal “tu” tone, similar to that employed in some social media sites, as opposed to the more formal “você” tone.
Basics of good writing style
- Write in a personal style, engaging and involving the user.
- Use active style and present tense. Use imperatives and talk to the user.
- Make sure the text is consistent and clear and correct in grammar and spelling.
- Write in short sentences.
- Use a positive tone, avoid negative expressions.
- Avoid ambiguity. Make sure that pronouns point clearly to the relevant nouns, and avoid long strings of modifiers or nouns.
Remember we are sailing on a jolly boat. Have fun! Play with the language. Be innovative and guide the readers onto a journey. Do not attempt to use humor, but use fresh and fun tone where it naturally fits. Remember that the most important part is delivering a clear message.
Note that in technical writing, descriptions and instructions should not include text that is written from a marketing point of view.
Language and culture
Because our communication is targeted to international use and part of it will be translated, try to keep the language culturally unambiguous, be careful of religious references, and avoid using idiomatic expressions or slang. The key aspects are clarity and simplicity. Consider these targets when adapting the jolly tone to the texts. In software UI translations: Respect the source text, but do not create word for word translations. Take the context into account when translating.
In all Sailfish OS translations, you should use the new European Portuguese spelling and grammar rules, as implemented by the new Orthographic Agreement. Whenever in doubt, please check the available resources (Jolla glossaries and translation memories, Infopedia and Priberam dictionaries, or Portal da Língua Portuguesa, for instance). Pay special attention to words that currently have two acceptable spellings (always check the project memories to ensure the utmost consistency).
When possible, leave out articles.
Please try to be informal if that feels natural in your language. Avoid mentioning pronouns.
Keep addressing consistent: e.g. if a paragraph was started using the second person, retain it throughout all its sentences (as opposed to switching to third person or neutral mood).
In European Portuguese, you should pay special attention to possessive pronouns, such as “seu” or “sua”, which should only be used when strictly necessary.
Use gender-neutral or all-inclusive terms to refer to human beings, rather than terms that include man, woman, and similar masculine and feminine terms.
- Chairperson: direção
Should it not be possible to use a gender-neutral term in your Portuguese translation, then you should use the appropriate masculine term ‒ diretor in this instance.
Use the present tense. E.g.:
- Correct: O leitor multimédia escolhe as músicas.
- Incorrect: O leitor multimédia irá escolher as músicas.
Whenever possible, use the active voice. Keep the message clear and the sentences short.
- Correct: Criar as Definições da Conta em…
- Incorrect: As Definições da Conta serão criadas em…
Use the imperative form.
- Correct: Entra nas Definições
- Incorrect: O Utilizador entra nas Definições
Capitalise application names and company names.
In the UI, start the first word with a capital letter.
Respect capitalisation rules of the language in question.
Observe the rules of European Portuguese under the new Orthographic Agreement (for instance, month names should be in lowercase, except when these appear at the start of a sentence or as a standalone menu option).
Menu style in the UI
User Interface menu items are named using verbs.
Empty states in the UI
User Interface empty states are typically written in the 2-sentence form, using verbs and active tone and, where possible, guiding the user towards the next possible steps to take. Keep sentences short and content informative. Where possible, guide user to reflect the good sides of an application or service (like referring to friends instead of contacts in the People app). For example:
(tell the situation, what items are missing) (point user to next actions)
No contacts yet. Pull down to add your friends.
App covers (that are shown in the Home) for empty states aim to be short informative messages. Length is typically two words.
In UI strings, do not use a full stop at the end of a sentence if there’s only one sentence. If there are two or more sentences, use full stops normally.
If the segment ends with the colon or ellipsis, the translation should follow the source.
In technical writing, use common abbreviations. Do not use Latin abbreviations.
In the UI, use common abbreviations, including Latin abbreviations. Make sure text clarity does not suffer. If in doubt, do not use an abbreviation.
Do not use a full stop in or after acronyms or initialisms, e.g.:
- Correct: WLAN
- Incorrect: W.L.A.N.
Do not use a full stop with unit (measurement) symbols, e.g.:
- Correct: kg
- Incorrect: kg.
Use a full stop with Latin abbreviations, e.g.:
- Correct: e.g., ca., etc.
- Incorrect: eg, ca, etc
Do not use contractions (e.g. aren’t, should’ve) in technical writing.
In the UI, contractions can be used when needed if the space is limited. Make sure that information given to the user is not lost because of such shortcuts.
Before using a contraction, try to rephrase the text so that contraction can be avoided. Omit words that are not essential for delivering the message clearly. If contracting cannot be avoided, minimize the number of words contracted. It is better to contract one word more than to contract several words a little.
Do not use a comma between independent clauses joined by and (e) and or (ou), even when one is used in the English source string. You should however use a comma between independent clauses joined by but.
- To open Account, go to Settings, and create new: Para abrir a Conta, entra nas Definições e cria uma nova
Use a comma to separate elements in a series, except for the last two elements.
- Create new, modify, and delete: Criar novo, modificar ou eliminar
Use a semicolon to separate items in a series when one or more items have internal punctuation.
Do not create plurals with parentheses. Consult translation tool user guide for handling the plurals.
Respect language’s quotation rules. A comprehensive list of marks can be found here: https://en.wikipedia.org/wiki/Quotation_mark#Summary_table_for_various_languages
Pay special attention to the new rules of hyphenation under the new Portuguese Orthographic Agreement. Whenever in doubt, please check the available resources. For example:
- Correct: autoestrada, hiper-resistente
- Incorrect: auto-estradainstead, hiper resistente
In technical writing, write lists with bullets.
In the UI, write lists without bullets or colons.
In technical writing, create structured, consistent and accurate headings. Consider verb structures in headings.
In technical writing, make sure each module can be read independently, containing all the needed information so that modules do not need to be read in any certain order.
In technical writing, when describing procedures, make sure to describe the steps clearly with only one task per step. Describe the expected results of those steps.
Write numbers as digits, including numbers below 10.
- Correct: 1 mensagem recebida
- Incorrect: Uma mensagem recebida
In European Portuguese, use a comma as decimal separator (eg. 2,5%) and a dot as thousand separator (ex. 1.000).
Use numerals for measurements.
Use a space between the numeral and the unit, except with degree and percentage sign. E.g.:
- Correct: 5 cm, 20°, 20 °C
- Incorrect: 5cm, 20 °, 20°C
Sailfish OS has a separate Terminology project to maintain consistency. Use that approved terminology when available.
Do not translate company names unless there is an official, translated name available.
Product names and trademarks
Do not translate product names or trademarks.
Safety information and legal texts
Warnings, cautions, and notes are legal texts that need to be confirmed with legal department. In case of legal texts, follow the instructions carefully and ask for more information if needed.
When finalising translations for the UI, check the following:
- Everything has been translated to your best knowledge.
- Spell check is done.
- Check consistency with the other translations done for the language.
- Ensure correct Sailfish OS terminology is used. If needed, propose new term entries.
- Confirm legal texts are consistent with the source.
- Company and product names, trademarks, symbols, and measurements have not been hyphenated.
- Ensure regional formats are retained, such as date, time, numeric and quotation literals.
When finalising texts for the technical writing, check these points as well:
- Titles and headings are structured and accurate.
- Language is clear and consistent.
- Sentences vary in length and have a clear form.