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