Skip to content

Commit

Permalink
Merge pull request #5 from w3c/feat/use-cases-template
Browse files Browse the repository at this point in the history
feat: add a use cases template for github issues
  • Loading branch information
hzbarcea authored Nov 12, 2024
2 parents 06f39d4 + b30c2f9 commit ecd586b
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/use-case.md
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.*

0 comments on commit ecd586b

Please sign in to comment.