Closed tdlowden closed 1 year ago
Flagging these resources as particularly useful references (they are linked to on the GitHub page):
There are a host of design considerations and anti-patterns noted in the first article, and great ideas for what to include in a template in the second and third.
As a developer of the system, I'd like to be able to keep track of system architecture decisions and understand why they were made, including what trade-offs and alternatives might have existed at the time. I'd also like to keep track of these in a place that I can refer back to later for historical context.
Acceptance Critera
notifications-api
)Implementation Sketch
There are several templates and recommendations we can draw from, including the following:
There are several others as well, including the template the cloud.gov team follows:
Whatever we choose, we ought to keep it lightweight to start with and build from that.
Security Considerations
ADRs, by their very nature, contain many details about a system and often delve into a variety of related bits of information. This includes trade-offs of taking one approach over another, oftentimes with implications to the security and stability of the overall system. Therefore, we'll want to be mindful of the following: