|
1 | 1 | --- |
2 | 2 | name: User Story |
3 | | -about: Capture a user story from stakeholders, ensuring a focus on user outcomes and clear communication. |
| 3 | +about: Capture a user story with clear outcomes and an easy-to-read list of what’s needed. |
4 | 4 | title: '' |
5 | 5 | labels: user-story |
6 | 6 | assignees: '' |
7 | | - |
8 | 7 | --- |
9 | 8 |
|
10 | 9 | **User Need** |
11 | 10 |
|
12 | | -**As a** (type of user) |
13 | | -**I want** (some action) |
| 11 | +**As a** (type of user) |
| 12 | +**I want** (some action) |
14 | 13 | **so that** (some result) |
15 | 14 |
|
16 | 15 | --- |
17 | 16 |
|
18 | | -**Functional Requirements (What):** |
19 | | - |
20 | | -- [ ] |
| 17 | +### What’s Needed |
21 | 18 |
|
22 | | -**Non-Functional Requirements (How):** |
| 19 | +List anything the solution must do or be (behaviour, performance, security, UX, etc.). |
23 | 20 |
|
24 | | -- [ ] |
| 21 | +- [ ] |
25 | 22 |
|
26 | 23 | --- |
27 | 24 |
|
28 | | -**Acceptance Criteria:** |
| 25 | +### Acceptance Criteria |
29 | 26 |
|
30 | | -- [ ] The functional and non-functional requirements are fulfilled. |
31 | | -- [ ] Changes (if any) during delivery are reflected in this story. |
32 | | -- [ ] Impacted users have been notified or communicated with appropriately (e.g., change logs, Slack, documentation updates). |
| 27 | +- [ ] Everything in **What’s Needed** is delivered. |
| 28 | +- [ ] Any changes during delivery are reflected in this story. |
| 29 | +- [ ] Impacted users have been informed appropriately (e.g. change logs, Slack, docs). |
33 | 30 |
|
34 | 31 | --- |
35 | 32 |
|
36 | | -**User Communication Plan (if applicable):** |
| 33 | +### User Comms Plan (if applicable) |
37 | 34 |
|
38 | | -Describe briefly how users will be informed about the change (e.g., Slack message, email, platform announcement). |
| 35 | +Briefly describe how you’ll let users know about the change. |
39 | 36 |
|
40 | 37 | --- |
41 | 38 |
|
42 | | -**Assumptions (optional):** |
| 39 | +### Assumptions (optional) |
43 | 40 |
|
44 | 41 | - |
45 | 42 |
|
46 | 43 | --- |
47 | 44 |
|
48 | | -**Risks and Mitigation (optional):** |
| 45 | +### Risks & Mitigation (optional) |
49 | 46 |
|
50 | 47 | - |
51 | 48 |
|
52 | 49 | --- |
53 | 50 |
|
54 | | -**Notes:** |
| 51 | +### Notes |
55 | 52 |
|
56 | | -(Add any additional context, links to diagrams, stakeholder interviews, etc.) |
| 53 | +(Add any extra context, links, diagrams, stakeholder interviews, etc.) |
57 | 54 |
|
58 | 55 | --- |
59 | 56 |
|
60 | 57 | <!-- Field explanations: |
61 | 58 |
|
62 | | -As a (type of user): The role that the stakeholder or user plays (developer, project manager, security team, etc.). |
| 59 | +As a (type of user): The role the stakeholder or user plays (developer, PM, security team, etc.). |
63 | 60 |
|
64 | 61 | I want (some action): The specific action, functionality, or change the user is requesting. |
65 | 62 |
|
66 | 63 | so that (some result): The benefit or reason behind the action. |
67 | 64 |
|
68 | | -Functional Requirements: What you are building — feature behaviours or system capabilities. |
69 | | -
|
70 | | -Non-Functional Requirements: How it should behave — performance, security, reliability, etc. |
| 65 | +What’s Needed: A single list covering both functional and non-functional aspects—what the feature must do and how it must behave (performance, security, reliability, etc.). |
71 | 66 |
|
72 | 67 | Acceptance Criteria: Clear, measurable conditions to verify the story is complete and valuable. |
73 | 68 |
|
74 | | -User Communication Plan: How users will be made aware of relevant changes or impacts (essential for user trust). |
| 69 | +User Comms Plan: How users will be made aware of relevant changes or impacts. |
75 | 70 |
|
76 | | -Assumptions: Important assumptions that inform how the story is delivered. |
| 71 | +Assumptions: Important assumptions informing delivery. |
77 | 72 |
|
78 | | -Risks and Mitigation: Risks associated with the story and how they will be handled. |
| 73 | +Risks & Mitigation: Risks associated with the story and how they will be handled. |
79 | 74 |
|
80 | | -Notes: Any other useful information. |
| 75 | +Notes: Any other useful information. |
81 | 76 |
|
82 | 77 | Tip: Update this story if the scope changes during delivery to maintain clarity for everyone. |
83 | 78 | --> |
| 79 | + |
0 commit comments