Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 81 additions & 0 deletions .github/ISSUE_TEMPLATE/use-case.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
---
name: Use Case
about: Use this template to propose a use case be elaborated collectively.
title: "[UC] <<brief description of use case>>"
champion: <<Name>> ( <<github handle>> )
labels: usecase
tags: [ <<tag 1>>, <<tag 2...>>]

---

## Summary

_<!-- Insert Title Here -->_

### Driving User Story

**As a [primary actor],**
**I want [an action or feature],**
**With [additional requirement or side-effect],**
**So that [a reason or benefit].**

## Context

- [ ] 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.

### Related Use Cases

<--! Leave empty if none; otherwise, a bullet list is best, whether annotated or not. -->

### Terminology

<!-- If you use any terms differently or more precisely than usual -->

### Actors

<!-- Enumerate every actor, server, service, process that will take an action or reaction, including storage, forwarding, etc.
Optionally, mark one actor as primary. -->

### Other Stakeholders

<!-- e.g. auditors, regulators, forensic accountants, martian anthropologists, etc. -->

## Flows

<!-- 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. -->

### 0 - Preconditions

<!-- What conditions must be in place or assumed before this use case can begin? -->

### 1 - Trigger

<!-- What (user or system) event or action initiates this use case? -->

### 2A - Happy Path

### 2B - Alternative Paths

<!-- Feel free to not just list these at a high level, but name these and add a #### heading for each, now or later -->

### 3A - Challenges and Key Risks

<!-- Can be failure modes/conditions or just more qualitative issues that affect satisfaction/safety less definitively.
Feel free to not just list these at a high level, but name these and add a #### heading for each, now or later -->

### 3B - Success Criteria

<!-- What conditions or criteria must be met for this use case to be considered successfully handled? What limitations are acceptable?
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? -->

### 3C - Acceptable Outcomes

<!-- 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. -->

## References

### Prior Art

<!-- 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 😉 -->

### Annotated Bibliography