Voz e conteúdo

Como o ME escreve — voz, mensagens e nomenclatura. Texto é UX.

O texto é parte da interface — um rótulo ou mensagem mal escrita custa mais que um pixel torto. Esta é a régua de como o ME escreve. O vocabulário (os termos exatos) fica no Glossário.

Princípios

  • Fale como o usuário fala — termos do dia a dia de compras, não jargão interno ou técnico.
  • Lidere pela ação — diga o que a pessoa faz ("Enviar para aprovação"), não o que o sistema fez ("Submissão efetuada").
  • Curto e claro — uma ideia por frase; corte a palavra que não muda o sentido.
  • PT-BR, sentence case — só a primeira maiúscula; nunca UPPERCASE em rótulo.

Mensagens

TipoComo escrever
ErroO que aconteceu + como resolver, sem culpar o usuário — "Não foi possível salvar. Verifique a conexão."
SucessoConfirme o resultado e ofereça o próximo passo — "Pedido criado. Ver pedido →"
VazioDiga o que apareceria ali + o CTA para criar o primeiro item

Qual mecanismo usar (toast efêmero vs alert persistente vs modal) → ver Feedback & Overlays.

Idioma e i18n

PT-BR sentence case é a voz padrão do guide — mas o ME é multilíngue. O EletroDS troca o idioma por usuário (en-US · pt-BR · pt-PT · es-ES/MX · fr-CA/FR) pelo LocalePicker / setupI18n do pacote @mercadoeletronico/eds-next; e telas de questionário suportam idioma por campo (o conteúdo respondido em locales diferentes).

  • Nunca cravar string solta — todo rótulo/mensagem é uma chave de i18n. A régua de voz vale para o PT-BR; as traduções seguem a mesma intenção (ação, clareza, sentence case na língua).
  • Idioma por campo quando o conteúdo é preenchido por quem responde em idiomas distintos (ex.: perguntas de cotação) — disponível como recurso no Compositor (Formulário → "Idioma por campo").
  • O idioma ativo da página (lang) é também critério de Acessibilidade.

Labeling

A régua única de como nomear ações e entidades no ME. Padrões e componentes seguem isto — não redefina rótulo caso a caso.

Nomenclatura de ações

ConvençãoQuandoExemplo
"Novo X"cadastro de uma entidade nova (registro mestre)"Novo fornecedor", "Novo usuário"
"Adicionar X"inserir um item existente num contêiner/lista"Adicionar item", "Adicionar fornecedor à cotação"
"Gerar X"derivar um documento de outro, dentro de um fluxo"Gerar Pré-Pedido", "Gerar Cotação"
"Novo documento → Tipo"split de procurement: o clique cria o tipo padrão, o caret revela os tiposRequisição · Cotação · Pedido · Leilão
Verbo no infinitivotoda ação de comando"Editar", "Excluir", "Filtrar" — nunca "Editando"/"Edição"

Distinguir Criar (permanente) × Adicionar (contextual) × Gerar (fluxo) previne ação equivocada.

Rótulos de ação — verbo + entidade explícita

✅ Bom❌ Ruim
Ver requisiçãoVer
Abrir detalhes do fornecedorAbrir
Consultar contratoDetalhes
Visualizar documento de transaçãoVisualizar
  • Verbo + a entidade explícita — não deixe o objeto implícito quando o contexto não basta.
  • Consistência entre listagem ↔ header do documento ↔ ações contextuais — o mesmo objeto, o mesmo nome.
  • Reflita a profundidade real (leitura resumida × detalhada).

O vocabulário completo (Subheader, Forehead, Filter bar, ações…) está no Glossário.