Dicas de casos de uso práticos em redator técnico para Redator Técnico

Prompt gerado automaticamente para Casos de uso práticos em Redator Técnico em Redator Técnico

5.0
33 usos
ChatGPT
Usar no ChatGPT
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.

Como Usar este Prompt

1

Clique no botão "Copiar Prompt" para copiar o conteúdo completo.

2

Abra sua ferramenta de IA de preferência (ChatGPT e etc.).

3

Cole o prompt e substitua as variáveis (se houver) com suas informações.

Compartilhe

Gostou deste prompt? Ajude outras pessoas a encontrá-lo!

Outros prompts de Redator Técnico

Continue explorando prompts nesta categoria.

Guia para testing em redator técnico em Redator Técnico

Prompt gerado automaticamente para Testing em Redator Técnico em Redator Técnico

Guia para fundamentos de redator técnico em Redator Técnico

Prompt gerado automaticamente para Fundamentos de Redator Técnico em Redator Técnico

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