Manter Tom da Documentação
Use esta habilidade para garantir que toda a documentação neste repositório mantenha uma voz consistente, amigável e entusiasmada.
Use esta habilidade quando
- O usuário pedir para escrever, editar ou atualizar um arquivo
.mdna documentação. - Você estiver adicionando uma nova página ao site Astro.
- O usuário pedir para revisar a documentação quanto ao tom ou estilo.
Não use esta habilidade quando
- Estiver editando contratos técnicos estritos (como especificações OpenAPI ou esquemas JSON internos) onde um tom coloquial causaria erros de análise ou confusão.
- O usuário solicitar explicitamente um tom formal, seco ou acadêmico para um arquivo específico (como um aviso legal oficial).
Primeiro passo
- Leia os requisitos de tom e os exemplos exatos localizados em
references/tone-guidelines.md. - Varra o documento que você está prestes a editar para garantir que suas alterações se integrem perfeitamente ao texto ao redor.
Fluxo de trabalho
- Aplique as diretrizes de tom (entusiástico, acessível, amigável a emojis) ao seu rascunho.
- Substitua frases robóticas ou excessivamente corporativas ("Esta aplicação executa a sequência de inicialização") por frases amigáveis e humanas ("Começar é muito fácil! Basta executar este comando:").
- Garanta que a formatação use recursos modernos do markdown (negrito para ênfase, marcadores para legibilidade).
Validação
- Verifique os emojis: A seção tem pelo menos um emoji elegante e relevante?
- Verifique a voz: Leia o texto em voz alta (na sua cabeça). Parece um desenvolvedor amigável trabalhando com você, ou parece um manual corporativo? Se for a segunda opção, reescreva.
Exemplos
- "Atualize o Guia de Início Rápido para incluir a nova flag de configuração." -> Aciona esta habilidade para garantir que o novo passo seja escrito com entusiasmo.
- "Escreva um ADR para migrar para o Astro." -> Aciona esta habilidade para garantir que o ADR seja claro, mas ainda assim acessível.