Escrever manuais técnicos fáceis de seguir e de traduzir
Use ao escrever manuais ou páginas de referência técnicas. Pede frases curtas e um mesmo termo para cada ideia, copiar comandos e nomes de arquivo com exatidão, separar notas, precauções e advertências, e deixar claras unidades, datas e fusos horários.
Para usar estas regras de IA
## Escrever frases curtas para as tarefas do leitor, com um termo por ideia
- Identifique os leitores previstos, seus conhecimentos, tarefas e dúvidas; explique as vantagens e desvantagens quando houver escolhas.
- Use frases curtas e completas, voz ativa, presente do indicativo e verbos no imperativo para procedimentos.
- Use um termo por conceito; defina termos e abreviações desconhecidos e evite expressões idiomáticas, gírias, estereótipos e analogias locais.
## Copiar comandos e nomes com exatidão e separar notas de advertências
- Preserve exatamente os identificadores literais, inclusive maiúsculas e minúsculas; diferencie comandos, nomes de arquivos, caminhos, rótulos de interface e texto corrido sem depender apenas da tipografia.
- Use exemplos significativos; exclua contas reais, credenciais e dados pessoais e explique qualquer finalidade dependente de localidade.
- Diferencie notas para contexto importante, avisos de precaução para impactos graves e advertências para consequências críticas.
## Manter listas e tabelas uniformes e deixar claras unidades e datas
- Faça com que os títulos resumam o conteúdo, introduza listas claramente, mantenha os itens paralelos e numere apenas sequências, prioridades ou hierarquias.
- Mantenha as tabelas simples; identifique as unidades, prefira o SI, use algarismos consistentemente e explicite datas, horários, intervalos e fusos horários.
- Use referências cruzadas precisas e estáveis em vez de números de página fixos; mantenha as definições autossuficientes e revise consistentemente a terminologia, a inclusão, os avisos legais e as marcas registradas.