A página `admin/customize/email_templates` deve incluir documentação breve desses templates

A solicitação:

A página de administração para personalizar modelos de e-mail deve incluir:

  • uma descrição de uma frase sobre quando o modelo atualmente selecionado será enviado por e-mail aos usuários
  • uma descrição de uma frase para cada chave de interpolação que pode ser usada no modelo atual.

A justificativa:

Nesta página, frequentemente me deparo com dois problemas:

1: não entender o que acionará o envio do modelo

O nome do modelo não é suficiente para entender quando um modelo de e-mail será enviado. Ótimos exemplos:

  • Modelo de E-mail de Convite Personalizado para Fórum
  • Modelo de E-mail de Convite Personalizado
  • Modelo de E-mail de Convite para Fórum
  • Modelo de E-mail de Convite

Esses nomes só fazem sentido retroativamente, depois que entendemos as distinções entre eles. Portanto, seria ótimo adicionar a essas (e a todos os modelos) uma pequena descrição de uma frase na página, para que o administrador saiba para que serve o modelo.

Você poderia usar diretamente o texto de um post útil sobre o assunto neste fórum — o conteúdo já está escrito, pelo menos para a localização em inglês.

2: não saber quais chaves de interpolação estão disponíveis ou o que elas fazem

Por exemplo, aqui está o modelo para Usuário Respondeu:

%{header_instructions}

%{message}

%{context}

%{respond_instructions}

O problema aqui:

  1. Não sei o que %{context} significa.
  2. Se eu excluir essas chaves, pode ser difícil recuperá-las novamente.

Portanto, também seria ótimo se houvesse descrições de uma frase para cada uma das chaves disponíveis para cada modelo de e-mail. Talvez como uma lista expansível/ocultável na página?

Como referência, aqui estão alguns posts buscando essas informações: um, dois

7 curtidas