Como escrever as mensagens

O texto da tela faz parte do componente. Um botão bonito com o rótulo "OK" não diz o que vai acontecer. Esta página traz as regras para os textos que mais se repetem: botões, erros, estados vazios, confirmações e avisos.

As regras seguem a ideia de linguagem simples da Recomendação CNJ nº 144/2023, de 25/08/2023, que recomenda aos tribunais o uso da linguagem simples nas comunicações e nos atos que editam. A recomendação serve aqui como referência para escrever; esta página não afirma que os sistemas cumprem todos os seus pontos.

Regras gerais

• Escreva para quem vai usar a tela, com as palavras que essa pessoa usa no trabalho: "medição", "contrato", "aditivo". Evite termos técnicos do sistema, como "registro", "payload", "requisição" e "ID".
• Frases curtas, na ordem direta e na voz ativa: "Salvamos o contrato", e não "O contrato foi salvo com sucesso pelo sistema".
• Uma ideia por frase. Se precisar de mais de duas frases, a tela provavelmente está explicando demais.
• Só a primeira letra maiúscula, como numa frase: "Novo contrato", e não "Novo Contrato".
• Sem ponto de exclamação, sem caixa alta e sem culpar a pessoa ("Você digitou errado").
• Números e datas no formato brasileiro: R$ 1.250.000,00, 10/11/2026.

Botões e links

• Comece pelo verbo e diga o que acontece: "Salvar medição", "Enviar para aprovação", "Baixar planilha".
• O mesmo verbo no título de uma confirmação e no botão que confirma: título "Excluir a medição 29?", botão "Excluir medição".
• Evite "OK", "Sim", "Confirmar" e "Clique aqui" sozinhos: fora de contexto, o leitor de tela lê só o rótulo.
• Para cancelar, use "Cancelar". Para voltar sem perder nada, use "Voltar".

Faça	Não faça
Salvar medição	OK
Excluir contrato	Sim
Ver a planilha do contrato	Clique aqui

Mensagens de erro

Uma mensagem de erro responde a duas perguntas: o que aconteceu e o que a pessoa pode fazer agora.

• Diga o que aconteceu em palavras comuns: "Não conseguimos salvar a medição".
• Diga o próximo passo: "Confira a conexão e tente de novo".
• No campo, diga como acertar, não só que está errado: "Informe a data da OS", "Use o formato 000/2026".
• Não mostre código de erro, nome de tabela ou mensagem em inglês. O código para a STI vai no code do BasePageState, à parte.

Faça	Não faça
Não conseguimos carregar as obras. Tente de novo em alguns minutos.	Erro 500: Internal Server Error
Informe o número do contrato.	Campo obrigatório inválido
A data de fim precisa ser depois da data de início.	Data inválida

Estados vazios

• Diga o que vai aparecer ali: "Nenhuma medição lançada".
• Diga quando aparece ou qual é o primeiro passo: "As medições deste contrato aparecem aqui assim que o apoio lançar a primeira."
• Depois de uma busca sem resultado, diga o que não foi achado e como sair: "Nenhuma obra com 'Alegre'", com o botão "Limpar busca".

Confirmações

• O título é uma pergunta com a ação e o objeto: "Excluir a medição 29?".
• A descrição diz a consequência: "A medição sai da planilha e não pode ser recuperada."
• O botão repete o verbo do título.

Avisos de sucesso

• Curtos, no passado, com o objeto: "Medição salva", "Contrato enviado para aprovação".
• Só avise o que a pessoa não vê acontecer na tela. Se o item novo já aparece na lista, o aviso é opcional.
• Ofereça "Desfazer" quando a ação puder ser desfeita.

Palavras que usamos

Use	Em vez de
Entrar, Sair	Logar, Deslogar, Logout
Salvar	Gravar, Persistir, Submeter
Excluir	Deletar, Remover registro
Tentar de novo	Retry, Recarregar a requisição
Sem permissão	Acesso negado, Forbidden, 403
Sessão expirada	Token expirado, Timeout