Create userstory-requirement.md (#305)

* Create userstory-requirement.md Initial user-story template for discussion. To be used by other TFs to create databases of user stories that can then be submitted to the UC TF for inclusion in the UC&R document. * Update REQUIREMENTS/userstory-requirement.md * Update userstory-requirement.md * Apply suggestions from code review Co-authored-by: Ted Thibodeau Jr <[email protected]> * Update userstory-requirement.md --------- Co-authored-by: Ege Korkan <[email protected]> Co-authored-by: Ted Thibodeau Jr <[email protected]>
w3c · Dec 11, 2024 · fdfdc97 · fdfdc97
1 parent b9ffb44
commit fdfdc97
Showing 1 changed file with 41 additions and 0 deletions.
diff --git a/REQUIREMENTS/userstory-requirement.md b/REQUIREMENTS/userstory-requirement.md
@@ -0,0 +1,41 @@
+# User Story
+Simple form for user-story based requirements.  While we have split 
+the elements into Who/What/Why, each of these should be written as if they fit
+into a sentence template of the following form:
+
+   *As a* Who *I need* What *so I can* Why.
+
+Each slot should be concise — no more than a single line.
+The "What" can be interpreted as a Technical Requirement,
+and the "Why" can be interpreted as a Functional Requirement.
+
+## Submitter
+- Information about person or group submitting requirement.
+- May not be the same as the stakeholders (e.g. may be WoT TF lead, etc).
+
+## Who (As a...): Stakeholder
+- User or Org (e.g. SDO) that needs capability
+- Optional additional stakeholders
+
+## What (I need...): Capability
+- Technical requirement
+- Noun phrase
+- May also be a Condition that needs to be satisfied (e.g., "minimize size")
+- **Link to at least one work item/issue/PR/assertion**
+- Details (optional):
+   - Free-form extra details; only if needed
+   - No more than one paragraph of four sentences.
+   - Extra details should be maintained in a separate document that links back to this user story
+
+## Why (so that I can...): Purpose
+- Functional requirement
+- Verb phrase
+- Solve a Problem
+- Meet an Objective
+- **Link to at least one Use Case or Use Case Category (e.g., "ease of use")**
+    - Propose a new category if necessary, linking to at least one use case
+- Details (optional):
+   - Free-form extra details; only if needed
+   - No more than one paragraph of four sentences.
+   - Extra details should be maintained in a separate document that links back to this user story
+