Edwin Kempin | c68ebd0 | 2019-08-07 11:56:21 +0200 | [diff] [blame] | 1 | --- |
| 2 | title: "Design Doc - ${title} - Use Cases" |
| 3 | sidebar: gerritdoc_sidebar |
| 4 | permalink: design-doc-${folder-name}-use-cases.html |
| 5 | hide_sidebar: true |
| 6 | hide_navtoggle: true |
| 7 | toc: false |
| 8 | folder: design-docs/${folder-name} |
| 9 | --- |
| 10 | |
Edwin Kempin | 78ae685 | 2019-08-01 15:27:44 +0200 | [diff] [blame] | 11 | # Use Cases |
| 12 | |
| 13 | In a few sentences, describe the use-cases as interactions between a |
| 14 | user and a system to attain particular goals. |
| 15 | |
| 16 | Should be understandable by anyone who is familiar with using Gerrit. |
| 17 | |
| 18 | Optionally, differentiate between primary and secondary use-cases. |
| 19 | Secondary use-cases are related to the primary use-cases, but |
| 20 | addressing them within the scope of this design is not mandatory. This |
| 21 | means they may not be covered by all proposed solutions. Secondary |
| 22 | use-cases that are not addressed by the concluded solution, may be |
| 23 | discussed in separate design docs. In this case links to these design |
| 24 | docs should be added here. |
| 25 | |
| 26 | Optionally, define non-goals. |
| 27 | |
| 28 | It is possible that use-cases are specific to custom setups (e.g. the |
| 29 | multi-master setup at Google). In this case, say so here. |
| 30 | |
| 31 | ## <a id="acceptance-criteria"> Acceptance Criteria |
| 32 | |
| 33 | Describe conditions that must be satisfied to consider the feature as |
| 34 | done. |
| 35 | |
| 36 | If a mentor is assigned, the mentorship ends when this state is reached. |
| 37 | Please note that a mentorship can also end earlier if the maximum time |
| 38 | frame for the mentorship has exceeded (see section 'Time Estimation' |
| 39 | in dev-design-doc-conclusion-template.txt). |
| 40 | |
| 41 | ## <a id="background"> Background |
| 42 | |
| 43 | Stuff one needs to know to understand the use-cases (e.g. motivating |
| 44 | examples, previous versions and problems, links to related |
| 45 | changes/design docs, etc.). |
| 46 | |
| 47 | Note: this is background; do not write about your design or ideas to |
| 48 | solve problems here. |