Estilo de escrita
Estilo de escrita
Seção intitulada “Estilo de escrita”Em um sistema logístico, o texto da interface é lido em movimento: no pátio sob o sol, com luva, no celular do motorista, no meio de uma fila de doca. Quem lê quer saber uma coisa: o que aconteceu com a minha carga e o que eu faço agora. Cada palavra a mais custa segundos, e segundos custam dinheiro.
Cinco princípios
Seção intitulada “Cinco princípios”| Princípio | Em uma frase | Exemplo |
|---|---|---|
| Direto | A informação mais importante vem primeiro. | Doca 3 indisponível às 14h. Escolha outro horário. |
| Preciso | Diga qual carga, qual placa, quanto. | Carga CG-1042 não despachada. |
| Neutro | Fala a voz do sistema, sem “você”, “eu” ou “nós”. | Nenhum alerta pendente. |
| Familiar | Usa a palavra que o operador já usa, não a do banco de dados. | Manifesto, não “documento de transporte”. |
| Consistente | Um conceito, um nome, em todo o produto. | Sempre Carga, nunca “Pedido” numa tela e “Remessa” em outra. |
| Quando dois princípios conflitam, Preciso e Direto vencem. Nunca sacrifique o significado para encurtar: um rótulo de três palavras claras é melhor que um de uma palavra vaga. |
Tom por situação
Seção intitulada “Tom por situação”O tom é sempre calmo e objetivo. O que muda é o peso.
| Situação | Tom | Evite |
|---|---|---|
| Rotina (rótulos, botões, títulos) | Neutro, curto | Frases completas em botões |
| Sucesso | Sóbrio, confirma e para | Comemorar. Exclamações, “Uhul”, “Parabéns” |
| Aviso | Objetivo, aponta o risco e o prazo | Alarmar sem necessidade |
| Erro | Calmo, específico, com saída | Culpar. “Você digitou errado”, “Ops!”, “Algo deu errado” |
| Ação destrutiva | Sério, diz exatamente o que será perdido | Suavizar. “Tem certeza?” sem dizer do quê |
| Espera | Informativo, diz o que está acontecendo | “Por favor, aguarde” |
Como montar uma mensagem
Seção intitulada “Como montar uma mensagem”Toda mensagem de feedback responde, nesta ordem:
- O que aconteceu, com o objeto específico (qual carga, qual campo).
- O que fazer, se houver o que fazer. | Sem saída | Com saída | | — | — | | Carga despachada. | Falha ao despachar a carga CG-1042. Motorista sem documento válido. Atualize o cadastro e tente de novo. |
- Se não há nada a fazer, só a primeira parte basta.
- Nunca esconda a causa em um código de erro. O código pode acompanhar, mas a frase vem antes.
- Mensagem sobre um dado específico traz o identificador (número da carga, placa, nota). É o que permite ao operador achar o problema sem procurar.
Capitalização
Seção intitulada “Capitalização”O MDS usa dois estilos, por tipo de elemento:
Caixa de título
Seção intitulada “Caixa de título”Cada palavra significativa começa com maiúscula. Ficam em minúscula artigos, preposições e conjunções (a, o, as, os, um, uma, de, da, do, em, no, na, para, por, com, e, ou).
- Gerar Relatório, Novo Agendamento, Excluir Rota, Ir para o Dashboard, Nenhuma Viagem Encontrada [Proposta] Essa é a adaptação para o português da regra “AP” hoje descrita na página, que fala em palavras de mais de três letras (uma regra pensada para o inglês). A regra por classe gramatical é mais fácil de aplicar e dá o mesmo resultado nos exemplos que já existem.
Caixa de sentença
Seção intitulada “Caixa de sentença”Só a primeira palavra e os nomes próprios começam com maiúscula. Siglas mantêm a grafia (NF-e, CPF, CNPJ, ETA).
- Carga despachada. · Peso total (kg) · Imprimir manifesto
O que usa cada uma
Seção intitulada “O que usa cada uma”| Elemento | Estilo | Exemplo |
|---|---|---|
| Botão | Título | Confirmar Entrega |
| Título de página, modal, drawer e EmptyState | Título | Excluir Rota? |
| Item de menu e aba | Título | Agendamento de Docas |
| Rótulo de campo | Sentença | Nome do motorista |
| Cabeçalho de coluna de tabela | Sentença | Data de coleta |
| Placeholder | Sentença | Ex: ABC-1234 |
| Toast, Alert, mensagem de erro | Sentença | Falha na conexão. |
| Tooltip | Sentença | Imprimir manifesto |
| Descrição, texto de ajuda | Sentença | Não há cargas nesta etapa do processo. |
| Status, badge | Sentença | Em trânsito |
| Texto de carregamento | Sentença | Gerando relatório… |
| Nunca use CAIXA ALTA em texto corrido ou rótulos. Ela é mais lenta de ler e, em telas pequenas, esconde a hierarquia. Se o design pede maiúsculas, aplique por estilo (CSS), sem digitar o texto em maiúsculas. |
Botões e ações
Seção intitulada “Botões e ações”- Verbo no infinitivo + objeto, em uma ou duas palavras: Salvar, Emitir Nota, Despachar Carga.
- Não repita o contexto. Se o título da seção é “Motoristas”, o botão é Adicionar, não “Adicionar Motorista”.
- O botão diz o que vai acontecer. Em confirmação, repita a ação: Excluir Rota, nunca “Sim” ou “OK”. O botão de saída é sempre Cancelar.
- Reticências (…) quando o clique abre outra janela ou pede mais dados antes de concluir: Configurar Filtros…, Imprimir…. Sem reticências quando a ação executa direto.
- Um único botão de destaque (primary) por contexto, com o verbo mais importante da tela.
- Link é descritivo. Ver detalhes da carga, nunca “Clique aqui”.
Verbos padrão
Seção intitulada “Verbos padrão”Use sempre o mesmo verbo para a mesma ação. Os que já aparecem no Notion são os de referência.
| Ação | Use | Evite |
|---|---|---|
| Gravar o que foi digitado | Salvar | Gravar, Submeter |
| Apagar de forma definitiva | Excluir | Deletar, Apagar |
| Interromper algo em andamento ou já criado, mantendo o histórico | Cancelar (Cancelar Carga) | Excluir, Anular |
| Tirar um item de uma lista ou vínculo, sem apagar o item | Remover [Proposta] | Excluir |
| Criar algo novo | Adicionar (dentro de uma lista) · Novo ou Criar (a partir de uma tela) | Inserir, Incluir |
| Procurar | Pesquisar | Buscar, Procurar |
| Fechar uma etapa positiva | Confirmar, Registrar, Concluir | Finalizar, Ok |
| Fazer sair para o destino | Despachar | Mandar |
| Gerar um documento fiscal | Emitir (Emitir Nota) | Gerar (reserve para relatórios) |
| Sair de um fluxo sem salvar | Cancelar ou Voltar | Sair |
Estados e status
Seção intitulada “Estados e status”Um status descreve onde a coisa está agora. Um botão descreve o que vai acontecer.
| Tipo | Forma | Exemplos |
|---|---|---|
| Ação (botão, menu) | Verbo no infinitivo | Despachar Carga, Registrar Entrega |
| Estado (status, badge) | Particípio ou expressão curta | Despachada, Em trânsito, Aguardando doca, Entregue, Atrasado |
| Processo em andamento | Gerúndio + reticências | Gerando relatório…, Salvando… |
| Resultado (Toast) | Particípio | Carga despachada. Alterações salvas. |
Pontuação
Seção intitulada “Pontuação”- Ponto final em mensagens de feedback e descrições (Toast, Alert, erro, EmptyState). Sem ponto em rótulos, botões, títulos, placeholders, status e tooltip de uma frase.
- Interrogação sempre que for pergunta, inclusive em título de modal: Excluir Rota?
- Sem exclamação. Ela alarma em erro e infantiliza em sucesso. [Proposta] Revisar “Tudo em Ordem!” do EmptyState.
- Reticências (o caractere único …, nunca três pontos) têm dois usos:
- Mais informação será pedida antes de concluir (Localizar…) ou a ação abre outra janela.
- Texto encurtado. Trunque no fim quando o começo é o que distingue (nome de cliente). Trunque no meio quando o fim distingue (placa, número de documento:
CG-10…2041).
- Não use reticências em placeholder, em tooltip nem em item de submenu (a seta já indica).
- Dois-pontos só antes de lista ou valor. Parênteses para unidade ou complemento curto: Peso total (kg).
- Abreviações com ponto (Nº, Av.) só quando o espaço exigir. Prefira a palavra inteira.
Vocabulário do setor
Seção intitulada “Vocabulário do setor”Um conceito, um nome. Escolha o termo do domínio e use sempre o mesmo, em todos os produtos (TMS, YMS, WMS, roteirização, rastreamento e MIA). Termos que já aparecem nas páginas do MDS: Carga, Frete, Viagem, Rota, Motorista, Transportadora, Manifesto, Nota, Agendamento, Pátio, Entrega, Registro, Documento, Anexo. [Proposta] Fechar com Produto e Operações a tabela oficial abaixo. Os exemplos são pontos de partida, não definições.
| Conceito | Termo oficial | Evite | Observação |
|---|---|---|---|
| Mercadoria a ser transportada | Carga | Pedido, Remessa (se forem coisas diferentes, defina cada uma) | |
| Deslocamento de um veículo | Viagem | Corrida, Trip | |
| Quem dirige | Motorista | Condutor, Driver | |
| Quem transporta | Transportadora | Transportador (em telas de cadastro pessoa jurídica) | |
| Local de espera e manobras | Pátio | Yard | YMS |
| Ponto de carga/descarga | Doca | Portão, Baia | |
| Chegada/saída registrada | Check-in / Check-out | Chegada e Saída (escolha um par e mantenha) | Termo em inglês já usado no setor |
Siglas e termos em inglês
Seção intitulada “Siglas e termos em inglês”- Siglas do setor conhecidas por todo operador podem ser usadas sem explicação: NF-e, CT-e, MDF-e, CPF, CNPJ, CEP, ETA.
- Siglas menos comuns vêm por extenso na primeira aparição ou no tooltip. Exemplo do Notion: ICMS com tooltip Imposto sobre circulação de mercadorias.
- Termos em inglês só quando são o nome do produto ou já são de uso corrente no setor (Dashboard, Check-in). Fora isso, use português.
Números, datas, unidades e documentos
Seção intitulada “Números, datas, unidades e documentos”| Tipo | Formato | Exemplo |
|---|---|---|
| Data | dd/mm/aaaa | 25/09/2026 |
| Hora | 24 h, com dois-pontos | 14:30 |
| Data e hora | Data, depois hora | 25/09/2026 14:30 |
| Data relativa | Só para o que é recente, com o tempo real | Atualizado há 2 min |
| Moeda | R, ponto no milhar, vírgula nos centavos | R 1.250,90 |
| Peso e volume | Número, espaço, unidade | 1.250 kg · 32,5 m³ |
| Distância | Número, espaço, unidade | 142 km |
| Duração | Unidade abreviada, sem ponto | 45 min · 2 h 10 min |
| Placa | Com hífen no formato antigo; sem hífen no Mercosul | ABC-1234 · ABC1D23 |
| CEP | Com máscara | 00.000-000 |
| CPF / CNPJ | Com máscara | 000.000.000-00 |
| Quantidade | Número, espaço, substantivo no número correto | 1 carga · 12 cargas |
- Plural e gênero corretos. Não use “carga(s)”. Escreva “1 carga” ou “12 cargas”. Implemente com regra de plural (ICU/
Intl.PluralRules), não com concatenação. - Sem “Zero”. Nenhuma carga, não “0 carga”.
- Fuso horário [Proposta]: em telas com operações em mais de um fuso, mostre o fuso explicitamente na primeira hora da tela (ex.: 14:30 (BRT)).
Exemplos do dia a dia
Seção intitulada “Exemplos do dia a dia”| Onde | Evite | Prefira |
|---|---|---|
| Toast após despachar | Sua carga foi despachada com sucesso agora. | Carga despachada. |
| Erro de emissão | Ocorreu um erro. | Falha na emissão da NF-e da carga CG-1042. Verifique o CNPJ do destinatário. |
| Confirmar exclusão | Tem certeza que quer apagar? | Título Excluir Rota? Corpo: A rota RT-2041 e seus 12 pontos de parada serão removidos. Essa ação não pode ser desfeita. Botões: Cancelar · Excluir Rota |
| Agendamento de doca | Não foi possível agendar. | Doca 3 indisponível às 14h. Escolha outro horário. |
| Veículo atrasado | Seu veículo está atrasado!! | Veículo ABC-1234 atrasado 45 min na parada 3. |
| Carregando | Por favor, aguarde enquanto carregamos… | Carregando viagens… |
| EmptyState | Ops, nada por aqui. | Nenhuma Viagem Encontrada. Não há viagens para o filtro selecionado. Ajuste os filtros. |
| Erro de campo | Você digitou o CPF errado. | CPF inválido. Insira apenas números. |
| Permissão | Você não pode fazer isso. | Sem permissão para excluir cargas. Solicite acesso ao administrador. |
| Status | O motorista está esperando no pátio. | Aguardando doca |
Acessibilidade e tradução
Seção intitulada “Acessibilidade e tradução”- Ícone sem texto sempre tem
aria-labele Tooltip com o nome da ação (Imprimir manifesto). - Não dependa de cor: “Erro” ou “Atrasado” entram por escrito, não só em vermelho.
- Não junte pedaços de frase no código. Cada frase é uma string completa, para poder ser traduzida e para o plural e o gênero funcionarem.
- Textos traduzidos crescem até cerca de 30%. Deixe espaço, e nunca corte o significado para caber.
Checklist de revisão
Seção intitulada “Checklist de revisão”- A informação mais importante vem primeiro?
- Diz qual carga, placa ou documento, quando há um específico?
- Tem “você”, “eu”, “nós”, “Ops” ou exclamação? Se tem, reescreva.
- Botão é verbo + objeto, em caixa de título, sem repetir o contexto da seção?
- Rótulos, mensagens e status estão em caixa de sentença?
- A mesma coisa tem o mesmo nome em todas as telas?
- Datas, moeda, peso e documentos seguem os formatos acima?
- Plural e gênero corretos, sem “(s)”?
- A mensagem de erro diz o que fazer, sem culpar?