diff --git a/guidelines/design-document-template.md b/guidelines/design-document-template.md new file mode 100644 index 0000000000..0ff8ab8a71 --- /dev/null +++ b/guidelines/design-document-template.md @@ -0,0 +1,34 @@ + + +# Design Document - My proposal + +## Overview + +### Motivation +Motivation to have this design document + +### Examples & Prior Art +Examples or references in how other solved similar or same problems + +## Design + +Discuss any background and motivation not already in the summary above. Give implementation details and possible alternatives to solve the problem including effects on other components. + +### Code / Implementation / Experiments +Code examples, alternative solutions + +### References/Links +Link to mocks, specs, and related features. + +## Follow up + +### Consensus +List decisions or agreements + +### Meeting notes +Link to meeting notes or add them inline