Documentation Of An Outgoing Communication

Some actions can trigger an email. Or an SMS, or a slack alert etc. All such outgoing communications should be documented on a dedicated document for that specific communication. Eg Email Confirmation Mail. If you send multiple communications for the same action, e.g. “Account Suspension Email” and “Account Suspension SMS”, these two should be documented as separate documents.

Name Of Communication

The name by which we will be calling the communication everywhere should be standardised here.

Overview

The action or logic that triggered the notification, along with who is the primary receiver of the notification should be mentioned here. If the communication is prompting the user to perform an action, that should also be listed in the overview.

Design / Template

The template of the mail/SMS/etc, with a sample screenshot on how the mail/SMS/etc appears should be included in the design section. If the communication is personalised based on some logic, the various states of the communication should be documented as subheadings.

Data

The data that is available to the template should be documented here.