Skip to main content
Warning This document has not been updated for a while now. It may be out of date.
Last updated: 21 Oct 2020

email-alert-api: 5. Record architecture decisions

Date: 2020-10-21


While we have already recorded architectural decisions for this project, there is no guidance to follow for writing new ones. Recently we found that creating a new ADR was hindered by wanting to be consistent with the structure of previous ADRs.


We will continue to use Architecture Decision Records, as described by Michael Nygard in this article:

We will adopt a structure for future ADRs that matches this document - the exemplar in our Rails app conventions. We will not change how the files are named, to avoid breaking links that were never expected to change.




ADRs preceding this one will have an inconsistent format to the ones that follow this.