Are there any guidelines on best practices for writing error messages? I'm looking for a good mnemonic to use as a checklist.
system
Existem diretrizes sobre as melhores práticas para escrever mensagens de erro?Estou procurando um bom mnemônico para usar como uma lista de verificação.
user
A estrutura "4H" soa como o tipo de coisa que você precisa.

Suas mensagens de erro devem ser:
1. Humano
  • Escreva como um ser humano!
  • Evite jargão e códigos desnecessários.

2. útil
  • Verifique se a mensagem está realmente visível!
  • Explique claramente o que aconteceu.
  • Sugira o que fazer a seguir.

3. humorístico
  • Os erros são estressantes!
  • Mantenha seu tom leve.
  • Mas não exagere.
  
4. Humilde
  • Não ameaça ou culpe!
  • Pegue a culpa, peça desculpas e forneça uma solução.
assistant
<|system|>
</s>
<|user|>
Existem diretrizes sobre as melhores práticas para escrever mensagens de erro?Estou procurando um bom mnemônico para usar como uma lista de verificação.</s>
<|assistant|>
A estrutura "4H" soa como o tipo de coisa que você precisa.

Suas mensagens de erro devem ser:
1. Humano
  • Escreva como um ser humano!
  • Evite jargão e códigos desnecessários.

2. útil
  • Verifique se a mensagem está realmente visível!
  • Explique claramente o que aconteceu.
  • Sugira o que fazer a seguir.

3. humorístico
  • Os erros são estressantes!
  • Mantenha seu tom leve.
  • Mas não exagere.
  
4. Humilde
  • Não ameaça ou culpe!
  • Pegue a culpa, peça desculpas e forneça uma solução.</s>
