|
| 1 | +# Title: Template for design documents |
| 2 | + |
| 3 | +Use this as a template to write a design document when adding new |
| 4 | +major features to the project. It helps other developers |
| 5 | +understand the scope of the project, validate technical complexity and |
| 6 | +feasibility. It also serves as a public documentation of how the feature |
| 7 | +actually works. |
| 8 | + |
| 9 | +## Review Period |
| 10 | + |
| 11 | +Best before Month, day year. |
| 12 | + |
| 13 | +## What is the problem? |
| 14 | + |
| 15 | +## Out-of-Scope |
| 16 | + |
| 17 | +## User Experience Walkthrough |
| 18 | + |
| 19 | +## Implementation |
| 20 | + |
| 21 | +### Project Changes |
| 22 | + |
| 23 | +_Explain the changes to api or command line interface, including adding new |
| 24 | +commands, modifying arguments etc_ |
| 25 | + |
| 26 | +### Breaking Change |
| 27 | + |
| 28 | +_Are there any breaking changes to the interface? Explain_ |
| 29 | + |
| 30 | +### Design |
| 31 | + |
| 32 | +_Explain how this feature will be implemented. Highlight the components |
| 33 | +of your implementation, relationships_ _between components, constraints, |
| 34 | +etc._ |
| 35 | + |
| 36 | +### Security |
| 37 | + |
| 38 | +_Tip: How does this change impact security? Answer the following |
| 39 | +questions to help answer this question better:_ |
| 40 | + |
| 41 | +**What new dependencies (libraries/cli) does this change require?** |
| 42 | + |
| 43 | +**What other Docker container images are you using?** |
| 44 | + |
| 45 | +**Are you creating a new HTTP endpoint? If so explain how it will be |
| 46 | +created & used** |
| 47 | + |
| 48 | +**Are you connecting to a remote API? If so explain how is this |
| 49 | +connection secured** |
| 50 | + |
| 51 | +**Are you reading/writing to a temporary folder? If so, what is this |
| 52 | +used for and when do you clean up?** |
| 53 | + |
| 54 | +### Documentation Changes |
| 55 | + |
| 56 | +_Explain the changes required to internal and public documentation (API reference, tutorial, etc)_ |
| 57 | + |
| 58 | +## Additional Notes |
| 59 | + |
| 60 | +_Link any useful metadata: Jira task, GitHub issue, …_ |
0 commit comments