Messages

Product messages are a functional dialog between the software and the user and are intended to lead the user to solve a problem or use a feature.

There are different types of product messages, e.g. error messages, success notifications, instructions, but regardless of their nature, they’re all key to provide a seamless and enjoyable user experience, since a clear and concise communication can guide users, and reduce their frustration and/or confusion.

Therefore, a product message must be easy to understand, clear, short and incisive. It must focus on the user, addressing their needs, and using a human.

Hence, in order for the communication to obtain the eXA team’s seal of quality, it must answer the following questions:

• Is it necessary?
• Is it short and simple?
• Is it direct and relevant?
• Is it instructive and clear?
• Isn’t it intrusive?

Message types

The first step in creating product messages is to look for similar messages in order to maintain consistency with the rest of the product’s content, since it is likely that a message with a similar structure already exists.

If it is really necessary to create a new message, we go up a “text level” according to the purpose of the message:

Level	Purpose of the message	Scenario	Example
0	Notify – it may not even require text, with visual indicators being preferable.	Field not filled in. Process in progress.	[form border in red] [loading, skeleton screen, etc.]
1	Inform – give the user the absolutely necessary information.	Impossible to access the system.	Incorrect password.
2	Describe– briefly explain the program’s behavior, asking for user intervention. You may need a dedicated window.	An action was requested without a contract being selected.	At least one line must be selected.
3	Detail– provide advanced help in complex scenarios. It is displayed in a dedicated window and can redirect to help content.	For detailed information on the error, the user is redirected to that view.	An error occurred while trying to initialize the subscription. For more information, see the system messages.

Supported languages

Spelling and syntax vary according to the linguistic variant of each language. In order to maintain consistency, it is important to always consider that the supported variants are he following:

• PT-PT: European Portuguese after the orthographic agreement;
• ES-ES: European Spanish;
• EN-US: US English.

In this section, you can find the examples of software messages seen before and their translations into the supported languages. Use this table to ensure your messaging is clear, consistent, and effective for a global audience.

English	Portuguese	Spanish (ES)
The changes will be applied the next time you open the form. Close and reopen to view them.	As alterações serão aplicadas na próxima vez que abrir o formulário. Feche e reabra para as visualizar.	Los cambios se aplicarán la próxima vez que se abra el formulario. Cierre y vuelva a abrir para verlos.
Incorrect IBAN format. Only SEPA countries are allowed.	Formato de IBAN incorreto. Apenas são permitidos países SEPA.	Formato de IBAN incorrecto. Solo se permiten países SEPA.
Two-factor Authentication. This authentication enhances your account’s security by requiring more than just a password.	Autenticação de Dois Fatores. Esta autenticação aumenta a segurança da sua conta ao exigir mais do que apenas uma palavra-passe.	Autenticación en Dos Fases. Esta autenticación mejora la seguridad de su cuenta al requerir algo más que una contraseña.
Would you like to enable it now?	Pretende ativá-la agora?	¿Desea activarla ahora?
An error occurred while processing the simulation contract:	Ocorreu um erro no processamento do contrato de simulação:	Se ha producido un error al procesar el contrato de simulación:
The contract must contain one earning with classification ‘salary’.	O contrato deverá conter uma remuneração com a classificação ‘vencimento’.	El contrato deberá contener una remuneración con la clasificación ‘vencimiento’.
The Tax ID length must be {0} digits.	O comprimento do NIF deve ser de {0} algarismos.	La longitud del NIF debe ser de {0} cifras.
The value entered is not a valid telephone number.	O valor introduzido não é um número de telefone válido.	El valor introducido no es un número de teléfono válido.
The value entered is not a valid email address.	O valor introduzido não é um endereço de email válido.	El valor introducido no es una dirección de correo electrónico válida.
Click here for help.	Clique para obter ajuda.	Haga clic para obtener ayuda.
The format of the entered Spanish TIN is not correct (only letters and numbers, no hyphens, periods or spaces). Valid formats: 0000000X, X000000Y, X000000.	O formato do NIF espanhol introduzido não está correto (apenas letras e números, sem hífenes, pontos ou espaços). Formatos válidos: 0000000X, X000000Y, X000000.	El formato del NIF español introducido no es correcto (solo letras y números, sin guiones, puntos ni espacios). Formatos válidos: 0000000X, X000000Y, X000000.
Invalid email format. Enter the format: account@server.	Formato de email inválido. Insira no formato: conta@servidor.	Formato de correo electrónico no válido. Introduzca el formato: cuenta@servidor.
The ‘Characteristics’ field contains invalid characters. Valid characters are: [a..Z,0..9,_,-].	O campo ‘Caraterística’ contém caracteres inválidos. Os caracteres válidos são: [a..Z,0..9,_,-].	El campo ‘Característica’ contiene caracteres no válidos. Los caracteres válidos son: [a..Z,0..9,_,-].
The notification must have a predefined template.	A notificação deve ter um modelo predefinido.	La notificación debe tener una plantilla predefinida.
The first two characters of the EU tax ID must match the prefix of the country indicated.	Os dois primeiros caracteres da identificação fiscal da UE devem corresponder ao prefixo do país indicado.	Los dos primeros caracteres del NIF de la UE deben corresponder al prefijo del país indicado.
You haven’t provided the national TIN. Do you want to continue and save it like this?	Não indicou o NIF nacional. Pretende continuar e guardar assim?	No ha indicado el NIF nacional. ¿Quiere continuar y guardarlo así?
You cannot save documents without lines.	Não pode guardar documentos sem linhas.	No puede guardar documentos sin líneas.
No information found for the selection made.	Nenhuma informação encontrada para a seleção realizada.	No se ha encontrado información para la selección realizada.
Are you sure you want to delete the delivery note nr. {0}? The associated documents will also be deleted.	Tem a certeza de que pretende eliminar a guia n.º {0}? Os documentos associados também serão eliminados.	¿Estás seguro de que deseas eliminar el albarán n.º {0}? Se eliminarán también los documentos asociados.
Quarter 2024-3T will be closed. Yu will not be able to create, edit or delete invoices, investment goods or expenses for this period. Do you want to continue?	O trimestre 2024-3T será encerrado. Não poderá criar, editar ou eliminar faturas, bens de investimento ou despesas para este período. Pretende continuar?	El trimestre 2024-3T se cerrará. No podrás crear, editar o eliminar facturas, bienes de inversión o gastos para este periodo. ¿Deseas continuar?
Drag up to 5 images of your expense or invoice (one per submission). OCR processing may take up to 2 business days.	Arraste até 5 imagens da sua despesa ou fatura (uma por apresentação). O processamento de OCR pode demorar até 2 dias úteis.	Arrastra hasta 5 imágenes de tu gasto o factura (una por envío). El procesado OCR puede tardar hasta 2 días hábiles.
The customer {0} created by the system has the fictitious TIN 00000000X, but there is already a customer with this TIN, so it could not be created. If you created it, select it below or create a new one manually in New Customer. Use an invalid TIN to avoid matching with real customers.	O cliente {0} criado pelo sistema tem o NIF fictício 00000000X, mas já existe um cliente com este NIF, pelo que não pôde ser criado. Se o criou, selecione-o abaixo ou crie um novo cliente manualmente em Novo Cliente. Utilize um NIF inválido para evitar que haja correspondência com clientes reais.	El cliente {0} creado por el sistema tiene el NIF ficticio 00000000X, pero ya existe uno con ese NIF, por lo que no se ha podido crear. Si lo creaste, selecciónalo abajo o crea uno nuevo manualmente en Nuevo Cliente. Usa un NIF no válido para evitar coincidencias con clientes reales.
Select the @1@ posting type.	Selecione o tipo de lançamento @1@.	Seleccione el tipo de asiento @1@.
The end date must be greater than the start date	A data final deve ser posterior à data inicial	La fecha final debe ser posterior a la fecha de inicio
This will start a batch operation in the background. Do you wish to continue?	Esta ação irá iniciar uma operação em lote em segundo plano. Pretende continuar?	Esta acción iniciará una operación en lote en segundo plano. ¿Desea continuar?
An error has occurred	Ocorreu um erro	Se ha producido un error
It is mandatory to define the ‘ReasonTypeKey’ argument.	É obrigatório definir o argumento ‘ReasonTypeKey’.	Es obligatorio definir el argumento ‘ReasonTypeKey’.
The X field is mandatory.	O campo X é obrigatório.	El campo X es obligatorio.
It is mandatory to fill in the X field.	É obrigatório preencher o campo X.	Es obligatorio rellenar el campo X.
You can only have one default model. Are you sure you want to select this company settings group?	Só pode ter um modelo predefinido. Tem a certeza de que pretende selecionar este grupo de definições da empresa?	Sólo puede tener un modelo por defecto. ¿Está seguro de que desea seleccionar este grupo de configuraciones de la empresa?
You must select an entity.	É necessário selecionar uma entidade.	Debe seleccionar una entidad
The document type is not supported for CIUS PT generation.	O tipo de documento não é suportado para a geração de CIUS PT.	El tipo de documento no se admite para generar CIUS PT.
To generate the invoice, click on Process.	Para gerar a fatura, clique na opção Processar.	Para generar la factura, haga clic en Procesar.
To export the document as a pdf, click te Export button.	Para exportar o documento em PDF, clique no botão Exportar.	Para exportar el documento en pdf, haga clic en el botón Exportar.
You can reconfigure your credentials at any time, using this button.	Pode reconfigurar as suas credenciais em qualquer altura, utilizando este botão.	Puedes reconfigurar tus credenciales en cualquier momento, usando este botón.

Good Practices

Building on the aspects seen previously, this section presents best practices for writing clear, efficient and user-centered messages. By applying these guidelines, you ensure the messages are not only easily understood by users, but also guide them effectively and create a positive experience.

• Be clear and concise;
• Use simple language;
• Use an active voice;
• Avoid ambiguity;
• Avoid repetition;
• Focus on the user;
• Use a human tone;
• Maintain consistency across the product’s messages and terminology;
• Ensure readability;
• Proofread messages for grammar and spelling
• Provide positive feedback.

Here are some examples to help you understand what a simple, user-focused product message looks like.

Be clear and concise

Use simple language

Messages should use simple terminology and simple verbs that focus first on the action, then on the steps the user has to take.

The use of technical jargon or unnecessarily long words should be avoided. These increase the length and complexity of the message.

Use an active voice

Passive voice can make messages seem unclear and distant. Using the active voice makes your messages more direct, engaging and easier for users to understand..

Avoid ambiguity

Ambiguous messages can confuse users and lead to mistakes. Make sure you give exact instructions to prevent confusion.

Avoid repetition

Repetitive information can frustrate users. Provide key points without restating the same details.

Focus on the user

The information contained in the messages should guide the human use of the product rather than explain the logic behind programming:

Human tone

It’s important to bear in mind that messages are a form of communication with the user, with the purpose of guiding them through the use of the product. For this reason, we should always maintain a human tone, using the active voice and positive constructions, directly addressing the user in a short, straightforward and natural way.

Proofread messages

Grammatical or spelling mistakes can damage the credibility of your message. Always proofread your messages to ensure they are professional, clear and error-free.