|
| 1 | +--- |
| 2 | +name: Use Case |
| 3 | +about: Use this template to propose a use case be elaborated collectively. |
| 4 | +title: "[UC] <<brief description of use case>>" |
| 5 | +champion: <<Name>> ( <<github handle>> ) |
| 6 | +labels: usecase |
| 7 | +tags: [ <<tag 1>>, <<tag 2...>>] |
| 8 | + |
| 9 | +--- |
| 10 | + |
| 11 | +## Summary |
| 12 | + |
| 13 | +_<!-- Insert Title Here -->_ |
| 14 | + |
| 15 | +### Driving User Story |
| 16 | + |
| 17 | +**As a [primary actor],** |
| 18 | +**I want [an action or feature],** |
| 19 | +**With [additional requirement or side-effect],** |
| 20 | +**So that [a reason or benefit].** |
| 21 | + |
| 22 | +## Context |
| 23 | + |
| 24 | +- [ ] I have looked for similar use cases and feel this issue is a distinct use-case, rather than best encoded as a variant or "alternate path" to an existing one. |
| 25 | + |
| 26 | +### Related Use Cases |
| 27 | + |
| 28 | +<--! Leave empty if none; otherwise, a bullet list is best, whether annotated or not. --> |
| 29 | + |
| 30 | +### Terminology |
| 31 | + |
| 32 | +<!-- If you use any terms differently or more precisely than usual --> |
| 33 | + |
| 34 | +### Actors |
| 35 | + |
| 36 | +<!-- Enumerate every actor, server, service, process that will take an action or reaction, including storage, forwarding, etc. |
| 37 | +Optionally, mark one actor as primary. --> |
| 38 | + |
| 39 | +### Other Stakeholders |
| 40 | + |
| 41 | +<!-- e.g. auditors, regulators, forensic accountants, martian anthropologists, etc. --> |
| 42 | + |
| 43 | +## Flows |
| 44 | + |
| 45 | +<!-- Feel free to write "TBD" or "N/A" for any subsections you don't have a clear answer for year, but don't remove them, it's a helpful reminder for later. --> |
| 46 | + |
| 47 | +### 0 - Preconditions |
| 48 | + |
| 49 | +<!-- What conditions must be in place or assumed before this use case can begin? --> |
| 50 | + |
| 51 | +### 1 - Trigger |
| 52 | + |
| 53 | +<!-- What (user or system) event or action initiates this use case? --> |
| 54 | + |
| 55 | +### 2A - Happy Path |
| 56 | + |
| 57 | +### 2B - Alternative Paths |
| 58 | + |
| 59 | +<!-- Feel free to not just list these at a high level, but name these and add a #### heading for each, now or later --> |
| 60 | + |
| 61 | +### 3A - Challenges and Key Risks |
| 62 | + |
| 63 | +<!-- Can be failure modes/conditions or just more qualitative issues that affect satisfaction/safety less definitively. |
| 64 | +Feel free to not just list these at a high level, but name these and add a #### heading for each, now or later --> |
| 65 | + |
| 66 | +### 3B - Success Criteria |
| 67 | + |
| 68 | +<!-- What conditions or criteria must be met for this use case to be considered successfully handled? What limitations are acceptable? |
| 69 | +To put it another way, what observable behaviors or metrics can be used to detect a failure more, or differentiate happy paths-or-outcomes from less-happy paths-or-outcomes? --> |
| 70 | + |
| 71 | +### 3C - Acceptable Outcomes |
| 72 | + |
| 73 | +<!-- Distinct from whether or not a flow was succesful or which outcome, what are the minimally required outcomes or side-effects (e.g. logs) across all outcomes. --> |
| 74 | + |
| 75 | +## References |
| 76 | + |
| 77 | +### Prior Art |
| 78 | + |
| 79 | +<!-- Highly recommend including links to blog posts, case studies, thought experiments, and prototypes that influenced this idea, including your own! good to have a [timestamped] snapshot if you want bragging rights about your input to the collective process 😉 --> |
| 80 | + |
| 81 | +### Annotated Bibliography |
0 commit comments