Design Doc Title
List stakeholders for project/feature.
|Other Dev 1 (Engine)|
|Other Dev 2 (Hub)|
Describe what you are trying to solve. Reference JIRAs etc. as needed.
List goals you are planning on achieving with the project/feature.
- Goal 1
- Goal 2
- Goal 3
List anything that should be called out explicitly as a non-goal (i.e., things that would not be addressed with this project/feature). This section is optional and can be left blank.
One-pager of the design and implementation plan. Can be high level and does not need to call out explicit functional code, though it is up to the owner on how deep they want to go.
What API endpoints will be exposed to the user as part of this feature?
List any external component and/or cross functional dependencies.
Plan for functional testing (automated, non-automated, etc).
Plan for performance testing (automated, non-automated, etc) if needed.
Plan for scale testing (automated, non-automated, etc) if needed.