Compartilhar via

Diretrizes de interface do usuário para extensões de classe auxiliar do NDF

  • Artigo

Ao criar sua classe auxiliar, você precisará criar texto para ajudar o usuário a entender a causa de um incidente e as possíveis etapas de reparo que podem ser executadas.

Causa raiz e reparo

Quando ocorrer um incidente, uma caixa de diálogo será exibida para informar o usuário sobre o que aconteceu. O texto que você criar aparecerá em duas áreas separadas.

  • Causa Raiz: uma breve descrição da causa do problema. Contém informações para ajudar um administrador ou usuário avançado a solucionar o problema.
  • Reparar: expande a causa raiz para fornecer mais detalhes sobre as etapas que um usuário pode seguir, sem ficar muito longo.

Cada causa raiz ou reparo deve ter um título e uma descrição. Todo o texto antes do primeiro caractere "\n" será usado para o título. Todo o texto após o primeiro caractere "\n" (incluindo as quebras de linha subsequentes) será usado para a descrição.

Diretrizes de título

O título de uma causa raiz ou reparo deve seguir estas diretrizes:

  • Deve ter 128 caracteres ou menos. (É recomendável ter 40 caracteres ou menos.)
  • Não deve terminar com um ponto final.

Diretrizes de descrição

A descrição de uma causa raiz ou reparo deve seguir estas diretrizes:

  • Deve ter 512 caracteres ou menos.
  • Cada frase deve terminar com um ponto final.
  • O caractere "\n" pode ser usado para criar uma quebra de linha na descrição.