Style Guide
If it’s to be documented, it has to be done with style.
- Structure
- Technical Language
- Orthography
- Formatting
The content structure influences the user experience, especially on websites and Help Centers with a large number of articles.
We should strategically design text graphic areas which make interpretation and reading easier.
Context
Getting the user into the context of the subject or the importance of the feature is essential so that they can contextualize themselves in the product and the operation to be carried out.
We must give priority to the user’s needs and answer their questions immediately.
O prazo de entrega do modelo P2 e 1074 termina a 12 de Maio.
Estes modelos são destinados aos pequenos retalhistas que se enquadram neste regime.
O prazo de entrega do modelo P2 e 1074 termina a 12 de Maio.
El FACe Punto General de entrada de facturas electrónicas es el sistema de envío de facturas electrónicas para la Administración General del Estado (AGE) en España.
ERP suporta el FACe Punto General.
This option allows to view the current accounts, purchases and sales documents (documents history).
This option allows to view the documents history.
Text Area
Spacing: Use blank spaces. Besides making the text easier to understand, it makes it more pleasant.
Managing invoices is one of the main tasks in any business.
Three types of invoice can be issued, depending on the sales requirements.
Managing invoices is one of the main tasks in any business. Three types of invoice can be issued, depending on the sales requirements.
Headings
Use headings to organize the article. Users need locatable, usable and relevant documentation.
But before using it, establish a hierarchy in the headings: H1, H2 and H3.
Family support
Scope of the support
Payment
Family support
Scope of the support
Payment
The headings have been designed to be short.
How to set up bank accounts?
How to set up one or more bank accounts in the ERP?
Avoid definite and indefinite articles and pronouns. We use infinitive verbs whenever possible.
Set permissions in the Administrator
Setting permissions in the Administrator
Adopting a careful and simple language demonstrates objectivity and clarity in your speech.
Simple
The main subject is always the first topic in the content. We should always think about the most important message to convey and make it the starting point of the writing. Don’t forget that we read in F.
Do not repeat information in the same article or area. It may be necessary to reinforce important points, but you should make a word search with the information, writing the same thing in different words.
If only a few words can be used, let’s not use twice as many.
O registo do ativo implica um conjunto de operações, nomeadamente, a capitalização e depreciação
O ativo implica um conjunto de operações, nomeadamente, a capitalização do ativo e depreciação do ativo.
The registration of the asset involves a series of operations, namely capitalization and depreciation
The asset involves a series of operations, namely the capitalization of the asset and the depreciation of the asset.
El registro del activo implica una serie de operaciones, en concreto la capitalización y la amortización
El activo implica una serie de operaciones, a saber, la capitalización del activo y la amortización del activo.
Empathetic
Don’t write for other people what you don’t want to be written for you. Always put yourself in the user’s shoes.
Be direct and straightforward. Leave no room for doubt.
Write short and concise whenever possible. Users suffer from a phobia of large texts..
As configurações são necessárias para o funcionamento da aplicação.
Por isso, preparamos uma checklist com todos os passos necessários.
A aplicação só funciona com determinadas configurações.
Consulte a checklist de configuração.
Configurations are necessary for the application to work.
Therefore, we have prepared a checklist with all the necessary steps.
.
The application only works with certain configurations.
See the configuration checklist.
Los ajustes son necesarios para que la aplicación funcione.
Por eso, hemos preparado una lista de comprobación con todos los pasos necesarios.
La aplicación sólo funciona con determinadas configuraciones.
Consulte la lista de comprobación de la configuración
.
Accessible
Make your text accessible to all types of user. Provide context and fit concepts into the product to encourage user interaction with the product.
Encourage the user to learn more. Identify related articles to offer new steps and features.
Comunicar documentos financeiros e de transporte é obrigatório.
Para conhecer todas as opções disponíveis, consulte o artigo de ajuda.
Comunicar documentos financeiros e de transporte é obrigatório.
O produto satisfaz todas as necessidades de reporte.
Communicating financial and transportation documents is mandatory.
To find out all the options available, see the help article.
Communicating financial and transportation documents is mandatory.
The product meets all reporting requirements.
Es obligatorio comunicar los documentos financieros y de transporte.
Para conocer todas las opciones disponibles, consulte el artículo de ayuda.
Es obligatorio comunicar los documentos financieros y de transporte.
El producto cumple todos los requisitos de información.
Adjusted
It’s very important that the words flow and help the user understand. Therefore, use adverbs, conjunctions and prepositions and divide complicated concepts into different sentences.
Use adjectives sufficiently.
Do not use metaphors or other similar stylistic devices.
Criar séries é uma operação importante para distinguir diferentes documentos.
Criar séries é uma operação valiosa para distinguir diferentes documentos.
Creating series is an important operation for distinguishing between different documents.
Creating series is a valuable operation for distinguishing between different documents.
La creación de series es una operación importante para distinguir entre distintos documentos.
La creación de series es una operación valiosa para distinguir entre distintos documentos.
Use the active voice whenever possible, as it reduces the formality of the writing and helps with text interpretation.
Após transferir stock para outro armazém, efetue um acerto de stock.
Após o stock ter sido transferido para outro armazém, efetue um acerto de stock.
After transferring stock to another warehouse, make a stock adjustment.
After the stock has been transferred to another warehouse, make a stock adjustment.
Después de transferir existencias a otro almacén, realice un ajuste de existencias.
Después de que las existencias se hayan trasladado a otro almacén, realice un ajuste de existencias.
Without errors, with connections and always with a period.
Products Names
The correct way to spell the products’ and applications’ names raises some doubts and sometimes they appear spelled differently.
Some of the most frequent cases are:
- Cegid Primavera ERP Evolution
- Cegid XRP Enterprise
- Cegid Jasmin
- Cegid Primavera Rose People
- Cegid Contasimple
In the case of Software as a Service products, the reference to this regime must be written at the end of the product name using its SaaS acronym in brackets..
- Cegid Primavera ERP Evolution Cloud (SaaS)
Note: These names may still be revised.
If in doubt, it is important to always check with the Branding team.
Conectors
In general, write short sentences and structured paragraphs. This allows for faster and more user-friendly reading.
Neste sentido
Desta forma
Para
Concluindo
Por fim
Mal
En este sentido
De esta manera
Para
Para concluir
Por último
Nada más
In this sense
Thus
To
In conclusion
Finally
As soon as
Punctuation
Semicolons in bullets
Periods in sentences
Question marks
Exclamation marks
Use graphic elements correctly to ensure uniform writing.
Quotation marks
Use only in quotations. Avoid using in menu options.
Access Human Resources | Salaries | Attendance | Absences
Access “Human Resources | Salaries | Attendance | Absences”
Bold
Use bold surgically to reinforce the key words of an article.
To filter the information, select the start date and end date of the period.
To filter the information, select the start date and end date of the period.
Italics
Use italics for words that don’t exist in the Portuguese dictionary.
Drill Down
Registry
Login path
Online
Download
Software
Initialisms
When using initialims, we don’t repeat the same information throughout the article.
However, when we mention it for the first time in the text, we should write the form in full, followed by the initialisms in brackets. Except for initialisms that belong to the public domain.
For more information on how to abbreviate messages, see the abbreviation rules.
Inquérito ao Emprego no Ensino Superior (IEESP)
IRC
I.V.A
FAQ’s
I.E.C.
Numbers
Put in digits starting from 0..
Write out decimal fractions in full.
Three quarters
12,5%
0,20
One thousand two hundred and thirty
0.20
3/4
Brackets
Use as necessary. In some cases, brackets in an article indicate to the reader that the information is accessory and they do not read it.
- “When processing, the respective discount is entered with the same value as the remuneration to cancel out the value of this remuneration since there is no value to be received (treatment of remuneration in kind).”
Hyphen between numbers
Includes before and after space.
1000 – 2000
1000-2000
English
Technical terms that don’t have an official translation in Portuguese or Spanish should be written in English.
Resource
Template
Adapter
We should also write words that, despite having a translation in Portuguese, are more commonly used in English.
Login
Link
Password
Dates
The date can be written in the following formats, depending on whether the text is more technical and short or more descriptive and long.
If we are referring to a period in the current year, we should not use the year because it is subjacent.
The end date is May 12th.
Updated on 12/03/2021
The end date is May 12th, 2021
Updated 12.03.2021
Hours
18h56
18h
18h56m
18h00
Monetary symbols
11,93 €
180 €
€11,93
180 euros