`admin/customize/email_templates`ページには、それらのテンプレートの簡単なドキュメントを含めるべきです

リクエスト:

管理ページでメールテンプレートをカスタマイズする際に、以下を含める必要があります。

  • 現在選択されているテンプレートがユーザーにいつ送信されるかの1文の説明
  • 現在のテンプレートで使用できる各補間キーの1文の説明。

根拠:

このページでは、しばしば2つの問題に遭遇します。

1:テンプレートが送信されるタイミングの理解不足

テンプレートの名前だけでは、いつメールテンプレートが送信されるかを理解するには不十分です。良い例を挙げます。

  • カスタム招待フォーラムメーラー
  • カスタム招待メーラー
  • 招待フォーラムメーラー
  • 招待メーラー

これらの名前は、それらの違いを理解した後でなければ、後付けでしか意味をなしません。そのため、これらのテンプレート(およびすべてのテンプレート)に、管理者がテンプレートの目的を知ることができるように、ページに短い1文の説明を追加すると素晴らしいでしょう。

このフォーラムの役立つハウツー投稿から直接テキストを使用できます。少なくとも英語のローカライズについては、コンテンツはすでに作成されています。

2:利用可能な補間キーやその機能の不明瞭さ

たとえば、User Replied(ユーザー返信)のテンプレートは次のようになります。

%{header_instructions}

%{message}

%{context}

%{respond_instructions}

ここでの問題点:

  1. %{context} が何を意味するのかわかりません。
  2. これらのキーを削除すると、元に戻すのが難しくなります。

そのため、各メールテンプレートで利用可能なキーごとに1文の説明があるとさらに良いでしょう。おそらく、ページ上で展開/折りたたみ可能なリストとして表示されるのではないでしょうか。

参考までに、この情報を求める投稿をいくつか紹介します。12

「いいね!」 7