Skip to content

Commit 0a08db7

Browse files
authored
Update Userstory-template.md
1 parent 3280d0b commit 0a08db7

File tree

1 file changed

+14
-22
lines changed

1 file changed

+14
-22
lines changed

documentation/Userstory-template.md

+14-22
Original file line numberDiff line numberDiff line change
@@ -16,29 +16,21 @@ This document specifies the template for documenting user stories related to API
1616
| Post-conditions | | M |
1717
| Exceptions | | M |
1818

19+
1920
Some notes related to the above template:
20-
<ul>
21-
<li> The <b> Support Qualifier </b> column allows capturing the need for specifying the item. <ins>Options -> M (Mandatory); O (Optional); CM (Conditional Mandatory)</ins>. </li>
22-
<li> The <b> Summary </b> item provides a user story description as a user persona, following the same syntax structure -> "<ins> <b>As a</b> (Persona), <b>I want</b> (Need), <b>so that</b> (Goal)" </ins>.</li>
23-
<ul>
24-
<li> A user story based on <em>user persona</em> focuses on expectations from the Point-of-View of an end-user. This is contrary to a user story based on <em>system persona </em>, which is designed to represent background system functions that do not require interaction from the end-user (i.e., elaborate on the behind-of-the-scenes integration tasks that are not user-centric).</li>
25-
</ul>
26-
<li> The <b>Roles, Actor(s) and scope</b> item allows linking a user story with existing Cloud/NaaS reference architectures. The architectures that are within the scope of CAMARA project are detailed in this document: https://github.com/telekom/telco-global-api-alliance/files/7065771/Reference.Architectures.pptx)
27-
<ul>
28-
<li> Roles: specifies the role(s) that the CAMARA API customer plays for the user story. <ins>Options -> customer:user; customer:administrator; customer:business manager</ins>. </li>
29-
<li> Actor(s): API usage should not be restricted to a particular actor (e.g., application service provider, hyperscaler, application developer, or end user where e.g. consent is required). Examples may use a particular actor to perform a role in the API flow, but that does not exclude other Actors from performing the role.
30-
<li> Scope: specifies the service lifecycle area(s) that the user story impacts on. <ins>Options -> Design time; Prospect to Order (P2O); Usage to Cash (U2C); Order to Activate (O2A); Trouble to Resolution (T2R)</ins>. </li>
31-
</ul>
32-
</li>
33-
</ul>
3421

22+
- The **Support Qualifier** column allows capturing the need for specifying the item. _Options -> M (Mandatory); O (Optional); CM (Conditional Mandatory)_.
23+
- The **Summary** item provides a user story description as a user persona, following the same syntax structure -> "**As a** (Persona), **I want** (Need), **so that** (Goal)".
24+
- A user story based on _user persona_ focuses on expectations from the Point-of-View of an end-user. This is contrary to a user story based on _system persona_, which is designed to represent background system functions that do not require interaction from the end-user (i.e., elaborate on the behind-the-scenes integration tasks that are not user-centric).
25+
- The **Roles, Actor(s) and scope** item allows linking a user story with existing Cloud/NaaS reference architectures. The architectures that are within the scope of the CAMARA project are detailed in this document: [Reference.Architectures.pptx](/documentation/SupportingDocuments/Reference.Architectures.pptx)
26+
- Roles: specifies the role(s) that the CAMARA API customer plays for the user story. _Options -> customer:user; customer:administrator; customer:business manager_.
27+
- Actor(s): API usage should not be restricted to a particular actor (e.g., application service provider, hyperscaler, application developer, or end user where e.g. consent is required). Examples may use a particular actor to perform a role in the API flow, but that does not exclude other Actors from performing the role.
28+
- Scope: specifies the service lifecycle area(s) that the user story impacts on. _Options -> Design time; Prospect to Order (P2O); Usage to Cash (U2C); Order to Activate (O2A); Trouble to Resolution (T2R)_.
3529

3630
# Linking a user story to API design
37-
Once we have the user story, the next step is to clarify the <b>data journey</b> in the context of the target and source systems we are integrating:
38-
<ul>
39-
<li> Think about triggers for workflows: how and when does data need to be moved between the application and the service? </li>
40-
<li> Think about dependencies of data objects: does the data in underlying objects need to be regularly kept in sync with another system? </li>
41-
<li> Think about any parameters the user might need to configure or change. This is particularly important when building self-serve integrations for non-technical end users.
42-
<li> Think about privacy by design: does any data represent sensitive information, and how can this be safely shared/stored according to regulation (e.g., anonymisation, tokenisation, zero-trust principles)
43-
</li>
44-
</ul>
31+
32+
Once we have the user story, the next step is to clarify the **data journey** in the context of the target and source systems we are integrating:
33+
- Think about triggers for workflows: how and when does data need to be moved between the application and the service?
34+
- Think about dependencies of data objects: does the data in underlying objects need to be regularly kept in sync with another system?
35+
- Think about any parameters the user might need to configure or change. This is particularly important when building self-serve integrations for non-technical end users.
36+
- Think about privacy by design: does any data represent sensitive information, and how can this be safely shared/stored according to regulation (e.g., anonymisation, tokenisation, zero-trust principles)

0 commit comments

Comments
 (0)