Prompt completo
Como redator técnico especializado em documentação de software, crie um guia prático e conciso para desenvolvedores, explicando **como escrever mensagens de erro eficazes e amigáveis para o usuário em APIs RESTful**. O guia deve abordar os seguintes pontos, com exemplos claros: 1. **Formato JSON padrão:** Qual a estrutura JSON recomendada para mensagens de erro (e.g., `code`, `message`, `details`, `field`) e por que ela é preferível? 2. **Linguagem clara e concisa:** Evitar jargões técnicos e usar vocabulário que o usuário final entenda. 3. **Ação corretiva sugerida:** Como guiar o usuário para resolver o problema (e.g., "Verifique se o campo 'email' está no formato correto"). 4. **Códigos de erro significativos:** A importância de usar códigos HTTP status corretos e, opcionalmente, códigos de erro internos específicos da aplicação. 5. **Localização (i18n):** Breve menção à importância de preparar as mensagens para tradução. O tom deve ser instrutivo e direto, como se estivesse conversando com um colega desenvolvedor.
Tags relacionadas
Redator Técnico
Casos de uso práticos em Redator Técnico
gerado-automaticamente
Como usar este prompt
1
Clique no botão "Copiar" para copiar o prompt para sua área de transferência
2
Acesse sua ferramenta de IA preferida (ChatGPT, ChatGPT, Claude, etc.)
3
Cole o prompt e adapte conforme necessário para seu contexto específico
Outros prompts de Redator Técnico
ChatGPT
Guia para troubleshooting em redator técnico em Redator Técnico
Prompt gerado automaticamente para Troubleshooting em Redator Técnico em Redator Técnico
3 usos
ChatGPT
Guia para fundamentos de redator técnico em Redator Técnico
Prompt gerado automaticamente para Fundamentos de Redator Técnico em Redator Técnico
4 usos
ChatGPT
Guia para melhores práticas em redator técnico em Redator Técnico
Prompt gerado automaticamente para Melhores práticas em Redator Técnico em Redator Técnico
5 usos