-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #5 from w3c/feat/use-cases-template
feat: add a use cases template for github issues
- Loading branch information
Showing
1 changed file
with
46 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
name: Use Case | ||
about: Use this template to propose an LWS use case. | ||
title: "[UC] <<brief description of use case>>" | ||
labels: triage, usecase | ||
|
||
--- | ||
|
||
**As a [primary actor],** | ||
**I want [an action or feature],** | ||
**So that [a reason or benefit].** | ||
|
||
## Preconditions: | ||
|
||
*What conditions must be in place or assumed before this use case can begin?* | ||
|
||
## Trigger: | ||
|
||
*What (user or system) event or action initiates this use case?* | ||
|
||
## Actors: | ||
|
||
*Describe the primary actor, and any other relevant actors involved in this use case* | ||
|
||
## Distinction: | ||
|
||
*What unique challenges or distinguishing factors (like technical issues, user experience needs, workflow integration, etc.) are associated with this use case?* | ||
|
||
## Scenario: | ||
|
||
*Describe an ideal or happy-case scenario where this use case would play out as intended.* | ||
|
||
## Alternative case(s): | ||
|
||
*What alternative flows or variations should the system handle for this use case?* | ||
|
||
## Error scenario: | ||
|
||
*What unexpected issues or errors might arise, and how should the system handle them?* | ||
## Acceptance Criteria: | ||
|
||
*What conditions or criteria must be met for this use case to be considered successfully handled? What limitations are acceptable?* | ||
|
||
## References: | ||
|
||
*List any relevant resources or examples that could inform this use case, possibly from other domains or solutions.* |