Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added design doc template #2029

Merged
merged 6 commits into from
Apr 17, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions design_documents/template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# <TITLE>

## Rationale of the solution
Provide use cases of the feature and general motivation why it is worth implementing/was implemented. You can also include some
existing solutions.

## User perspective description of the solution
Provide only if documentation doesn't already exist and if the feature is user-facing.
Provide an overview of the feature API from the user perspective. Consider it a draft documentation which you can later reuse as documentation.

## Technical overview of the solution
Provide a rough description of the feature implementation. Keep it high level. Try to include your mental model if possible.
Try to include motivation behind non-obvious technical decisions. This is important so we don't have to rethink details and motivations it every time.
If something is an open question include it as well.


## Implementation plan
Optional - provide only if feature is not implemented and you have some steps in mind which you will take. Keep it high level!

Loading