byescaleiraDocumentação

Fundamentos

Escrita

O texto também é parte da identidade.

#Voz

  • Português do Brasil, a não ser que o produto seja em outra língua.
  • Voz ativa, frases curtas, no tom de quem explica a um colega. Sem jargão de sistema: "o lote foi recusado", não "erro 409".
  • Descreva o que a coisa faz, não venda: "Prepara os eventos do dia", não "Revolucione sua agenda".
  • Nomeie pelo que a pessoa entende, não pelo que o sistema chama: "notificações", não "webhooks".

#Botões e ações

  • O botão diz o que acontece: "Aprovar 3 eventos", "Salvar configuração", "Tentar de novo".
  • A mesma ação tem o mesmo nome no fluxo inteiro: o botão "Aprovar" leva a "Aprovado".
  • Nunca "OK", "Enviar", "Clique aqui" ou "Saiba mais" sozinho.

#Erros, avisos e vazios

  • O erro diz o que aconteceu e o que fazer, sem pedir desculpa: "Código incorreto. Confira o código; depois de 5 erros, espere 15 minutos."
  • O vazio convida a agir: "Nenhum lote ainda. Peça o dia ao Claude."
  • O aviso cabe em uma frase. Se precisa de duas, a primeira é o fato e a segunda, o que fazer.

#Forma

  • Sem rótulo em caixa alta, sem "sobretítulo" acima de cada título.
  • Sem metadados unidos por "·". Use vírgula, ponto ou linhas separadas.
  • Sem "→" no fim de link ou botão, nem "—" ligando rótulo e fragmento.
  • Destaque uma palavra só com peso (600), nunca com cor ou itálico.
  • Datas:
    • o formato do produto no destaque (ex.: 28.09);
    • dd/mm/aaaa no texto corrido;
    • aaaa-mm-dd só em código.
  • Números:
    • separador de milhar com ponto e decimal com vírgula;
    • unidade com espaço ("15 min");
    • porcentagem colada ("93%").

#Dados sigilosos

O que é público nunca mostra dado real de cliente, processo, paciente ou pessoa da equipe. Isso inclui:

  • a landing page;
  • o login;
  • a documentação;
  • os slides de apresentação;
  • as capturas de tela.

Mostre o formato ("Processo e apelido do cliente") ou dados inventados que pareçam inventados. Dados reais, só dentro do produto, para quem entrou.