[Technical spec template]
Template page for technical specifications that describe how to implement a given deliverable.
Summary details
| Field | Value |
|---|---|
Deliverable | [Link to deliverable spec] |
Key sections |
Architectural decisions
[Technical decision 1]
[1-2 sentences describing the technical decision that needs to be made. Repeat this section and its subsections for each decision that needs to be made.]
Options
[Option 1]
[Option 2]
Decision drivers
[Evaluation criteria that should inform this architectural decision]
[Evaluation criteria that should inform this architectural decision]
Technical milestones
[Milestone 1]
[Description of what needs to be accomplished in this milestone, or link to a more detailed spec.]
Implementation
Translations
Does this deliverable involve delivering any content that needs translation?
[to be added]
If so, when will English-language content be locked? Then when will translation be started and completed?
[to be added]
Services going into PROD for the first time
This can include services going into PROD behind a feature flag that is not turned on.
[to be added]
Services being integrated in PROD for the first time
Are there multiple services that are being connected for the first time in PROD?
[to be added]
Data being shared publicly for the first time
Are there any fields being shared publicly that have never been shared in PROD before?
[to be added]
Security considerations
Attack vectors introduced
Does this deliverable expose any new attack vectors or expand the attack surface of the product?
[to be added]
Mitigation strategies
If so, how are we addressing these risks?
[to be added]
Logs
Change log
Major updates to the content of this page will be added here.
| Date | Update | Notes |
|---|---|---|
Last updated