CommunityEscrita e Ediçãogithub.com

jakubkrehel/better-writing

Focado em melhorar o texto do produto no seu projeto.

O que é better-writing?

Esta skill é uma ferramenta de revisão e orientação para garantir que o texto de um produto mantenha consistência, clareza e uma linguagem apropriada. Ela ajuda desenvolvedores e redatores a evitar armadilhas comuns, como termos inconsistentes, tom inadequado e instruções confusas. A skill fornece um guia completo de estilo, desde a escolha de palavras até a estrutura de botões, links e mensagens de erro. É útil para qualquer projeto que queira aprimorar a experiência do usuário através de uma comunicação mais eficaz, seja em interfaces web, mobile ou aplicações desktop. A skill funciona como um conjunto de princípios a serem seguidos durante a revisão de texto, e inclui um sistema de reporte com severidade (HIGH, MEDIUM, LOW) para priorizar as correções.

Funciona com~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/jakubkrehel/skills/tree/main/skills/better-writing

Installed? Explore more Escrita e Edição skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

Perguntar na sua IA favorita

Abre um novo chat com esta habilidade de agente já pré-carregada.

Documentação

Escrita de interface

Claro e breve vence engenhoso; consistente vence variado. A melhor mensagem de erro é a interação redesenhada para que o erro não ocorra.

Como o texto é renderizado (capitalização via text-transform, truncamento, pontuação inteligente) pertence a better-typography. Marcação de erro e anúncios (aria-invalid, regiões ativas) pertencem a better-accessibility. Espaço para strings traduzidas pertence a better-layout.

Reconhecer a voz existente

Antes de escrever ou revisar, leia o texto ao redor. Observe a terminologia do produto, suas convenções de localização e qualquer guia de estilo de voz ou conteúdo.

Uma voz de marca deliberada não é um defeito. Levante um desvio da linguagem simples apenas quando ele criar inconsistência, ambiguidade, risco de tradução ou um tom que a gravidade da situação não suporta.

Uma voz, tom flexível

O produto tem uma voz e o texto existente a estabelece. Uma edição local não pode inventar uma nova. Mantenha os termos consistentes: se é "Arquivar" no menu, não é "Mover para o armazenamento" no toast. O tom se ajusta à gravidade:

ContextoTom
Sucesso, integração, estados vaziosAcolhedor, pode ser leve
Ações rotineiras, configuraçõesNeutro, mínimo
Erros, confirmações destrutivasCalmo, simples, sem brincadeiras
Perda de dados, segurançaSério, explícito

Dirija-se ao leitor diretamente

Em texto instrucional, escreva "você", não "o usuário". Em erros, "nós" convida ambiguidade e parece uma fuga de responsabilidade, então prefira "Não foi possível carregar o conteúdo" em vez de "Estamos com dificuldades para carregar este conteúdo". Uma voz em primeira pessoa estabelecida pode permanecer em textos de baixa gravidade onde ainda se leia claramente.

Use possessivos com moderação: "Favoritos" vence "Seus Favoritos". Mantenha uma perspectiva ao longo de um fluxo.

Palavras simples em vez de engenhosas

Escolha palavras que um leitor cansado entenda na primeira leitura e elimine toda palavra que não faz trabalho. Sem expressões idiomáticas, sem coloquialismos, sem humor que não se traduza.

Evite gênero desnecessário: "Assinantes podem postar receitas", não "cada assinante pode postar suas receitas". Corresponda ao dispositivo de entrada: "toque" em tela sensível ao toque, "clique" com um ponteiro, "selecione" quando ambos são possíveis.

Nunca monte uma frase a partir de fragmentos em torno de uma variável ("Você tem " + n + " novas mensagens"), porque a ordem das palavras muda por idioma. Use uma string de modelo completa com pluralização apropriada.

Botões com verbo primeiro

Um rótulo de botão começa com um verbo nomeando a ação: "Enviar", "Salvar rascunho", "Excluir projeto". Nunca "OK!", "Vamos lá!" ou um "Sim" e "Não" simples em uma ação consequente.

Um botão de confirmação repete a consequência, para que a caixa de diálogo possa ser respondida sem ler o corpo. "Excluir este projeto?" oferece Excluir projeto e Cancelar.

Vocabulário consistente de fluxo

Um fluxo de várias etapas usa um vocabulário do início ao fim: "Começar" para entrar, "Continuar" ou "Avançar" (escolha um) para avançar, "Concluir" para finalizar. Sinônimos alternados fazem os usuários se perguntarem se os botões fazem coisas diferentes.

Links descrevem seu destino

O texto do link precisa fazer sentido fora de contexto, porque usuários de leitores de tela navegam por uma lista dos links da página. Escreva "Leia a documentação de faturamento". "Clique aqui" falha nisso e na regra do verbo do dispositivo ao mesmo tempo.

Um simples "Saiba mais" quebra assim que dois aparecem em uma página. Acrescente um sufixo a cada um: "Saiba mais sobre exportações".

Uma política de capitalização

Escolha título ou frase para cada tipo de elemento e aplique a todas as instâncias desse tipo. Frase é o padrão mais seguro. É mais calmo, não tem regras por palavra para lembrar e se localiza de forma limpa. "Salvar Alterações" ao lado de "Descartar alterações" parece descuido.

Configurações descrevem o estado ATIVO

Rotule uma opção para o que acontece quando ela está ativada. "Enviar recibos de leitura" permite que os usuários infiram o estado desativado; a negativa ("Não enviar recibos de leitura") transforma a opção em uma dupla negativa.

Link direto para uma configuração referenciada em vez de descrever o caminho até ela: um link "Configurações de notificação", não "Vá para Configurações > Notificações > E-mail".

Erros dizem como corrigir, ao lado de onde quebrou

Um erro é uma instrução e pertence ao lado do campo que falhou:

RuimBom
Essa senha é muito curtaEscolha uma senha com pelo menos 8 caracteres
Nome inválidoUse apenas letras para o seu nome
Opa! Algo deu errado.Não foi possível salvar. Verifique sua conexão e tente novamente.

Sem culpa, sem "opa", sem pontos de exclamação. Formule dicas de forma positiva ("Use apenas letras", não "Não use números ou símbolos") e mostre-as antes do erro, não depois. Quando o mesmo erro persiste, redesenhe a interação em vez de reformular o texto.

Estados vazios apontam para frente

Um estado vazio diz o que é este lugar, como preenchê-lo e oferece uma ação clara:

<!-- Ruim: um encolher de ombros -->
<p>Sem resultados.</p>

<!-- Bom: orientação mais um próximo passo -->
<p class="font-medium">Nenhum projeto ainda</p>
<p class="text-sm text-zinc-500">Projetos mantêm suas tarefas e arquivos juntos.</p>
<button class="mt-4">Criar um projeto</button>

Um estado vazio de pesquisa ou filtro nomeia a consulta e oferece uma saída: "Sem resultados para 'trimestral'. Limpar filtros". Nunca coloque informações permanentes em um estado vazio. Elas desaparecem assim que o conteúdo existe.

Placeholders são exemplos, não rótulos

Um placeholder mostra o formato esperado: [email protected], DD/MM/AAAA. Ele desaparece ao digitar, então nunca é o único rótulo. Todo campo mantém um visível.

Reporte

Severidade. ALTA engana o usuário ou esconde como se recuperar de um erro. MÉDIA quebra consistência de voz, terminologia ou capitalização. BAIXA é polimento de redação isolado.

Verificação. A fonte por si só é suficiente aqui. Verifique cada rótulo contra a ação que invoca, cada erro por uma correção declarada e a terminologia contra o texto ao redor. Nenhuma verificação de navegador é necessária.

Formato. Agrupe descobertas sob o princípio que cada uma viola, ordenadas por severidade, uma linha por causa raiz listando cada local onde aparece:

SeveridadeLocalAntesDepoisPorquê

Local é caminho/para/arquivo:linha. Porquê nomeia o princípio e o impacto no usuário.

Termine com Bloquear quando alguma ALTA permanecer, Aprovar caso contrário, deixando o restante na tabela como trabalho a fazer. Nunca Aprovar cobertura que não inspecionou. Sem nada a relatar, declare "Nenhum achado acionável de redação" e relate verificação.

Individual skills in this repo

This repo contains 7 individual skills — each has its own dedicated page.

Habilidades Relacionadas