mirror of
https://github.com/GSA/notifications-api.git
synced 2026-01-24 03:21:51 -05:00
6c6026acf7
This changeset updates our ADR documentation to include notes on draft and private ADRs that need to live outside of GitHub. It updates the README with this information and also introduces an "implemented" flag in addition to the ADR status itself. This is reflected in the ADR templates. Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
117 lines
3.2 KiB
Markdown
117 lines
3.2 KiB
Markdown
# TITLE: ADR Title Here
|
|
|
|
|
|
| CREATED DATE | LAST UPDATED | STATUS | IMPLEMENTED | AUTHOR | STAKEHOLDERS |
|
|
| :---: | :---: | :---: | :---: | :---: |
|
|
| Date when ADR was created - MM/DD/YYYY format | Date when ADR was last updated - MM/DD/YYYY format - or N/A | Current ADR status - one of Proposed / Accepted / Rejected / Deprecated / Superceded By ADR - link to ADR | Yes or No | GitHub username(s) of author(s) | GitHub username(s) or team name(s) of other folks involved |
|
|
|
|
|
|
## CONTEXT AND PROBLEM STATEMENT
|
|
|
|
**OPEN ISSUE(S):** Link(s) to related issue(s) here, if applicable.
|
|
|
|
Explain the nature of the problem, challenge, or decision to be made here. Be as
|
|
succinct as possible, but don't leave out any details. State things matter of
|
|
factly and as objectively as you can.
|
|
|
|
|
|
## DECISION DRIVERS
|
|
|
|
List anything that plays a major role in making a decision here. These could
|
|
be one or more of the following:
|
|
|
|
- Desired qualities
|
|
- Desired outcomes
|
|
- Primary concerns
|
|
- Constraints
|
|
- ... (anything else pertinent to the decision-making process)
|
|
|
|
|
|
### SECURITY COMPLIANCE CONSIDERATIONS
|
|
|
|
Because we work in a regulated space with many compliance requirements, we need
|
|
to make sure we're accounting for any security concerns and adhering to all
|
|
security compliance requirements. List them in this section along with any
|
|
relevant details:
|
|
|
|
- Security concern 1
|
|
- Concern detail 1
|
|
- Concern detail 2
|
|
- Concern detail ...
|
|
|
|
- Security concern 2
|
|
- Concern detail 1
|
|
- Concern detail 2
|
|
- Concern detail ...
|
|
|
|
|
|
## CONSIDERED OPTIONS
|
|
|
|
List all options that have either been discussed or thought of as a potential
|
|
solution to the context and problem statement. Include any pros and cons with
|
|
each option, like so:
|
|
|
|
- **Name of first option:** A brief summary of the option.
|
|
- Pros:
|
|
- Pro 1
|
|
- Pro 2
|
|
- Pro ...
|
|
|
|
- Cons:
|
|
- Con 1
|
|
- Con 2
|
|
- Con ...
|
|
|
|
- **Name of second option:** A brief summary of the option.
|
|
- Pros:
|
|
- Pro 1
|
|
- Pro 2
|
|
- Pro ...
|
|
|
|
- Cons:
|
|
- Con 1
|
|
- Con 2
|
|
- Con ...
|
|
|
|
|
|
## PROPOSED OR CHOSEN OPTION: Proposed/Chosen Option Title Here
|
|
|
|
Summarize the decision for the proposed/chosen option here. Be as concise and
|
|
objective as possible while including all relevant details so that a clear
|
|
justification is provided. Include a list of consequences for choosing this
|
|
option, both positive and negative:
|
|
|
|
|
|
### Consequences
|
|
|
|
- Positive
|
|
- Positive consequence 1
|
|
- Positive consequence 2
|
|
- Positive consequence ...
|
|
|
|
- Negative
|
|
- Negative consequence 1
|
|
- Negative consequence 2
|
|
- Negative consequence ...
|
|
|
|
|
|
## VALIDATION AND NEXT STEPS
|
|
|
|
This section likely won't be filled out until a decision has been made by the
|
|
team and the ADR is accepted. If this comes to pass, then write up the criteria
|
|
that would ensure this ADR is both implemented and tested correctly and
|
|
adequately. This could be a short summary and/or a list of things:
|
|
|
|
- **Criterion name 1:** Description of criterion 1
|
|
- Requirement or action 1
|
|
- Requirement or action 2
|
|
- Requirement or action ...
|
|
|
|
- **Criterion name 2:** Description of criterion 2
|
|
- Requirement or action 1
|
|
- Requirement or action 2
|
|
- Requirement or action ...
|
|
|
|
Lastly, include a link(s) to an issue(s) that represent the work that will
|
|
take place as follow-ups to this ADR.
|