Corrects Confusion between User Stories and Use Cases

As discussed in the ML[1], this commit attempts to clear
up confusion between the conflicting use of the terms
"User Story" and "Use Case" in our template and User Story
files.

[1] http://lists.openstack.org/pipermail/user-committee/2017-January/001586.htm

Change-Id: I26f4b7a8f468852c0f166ffc84050e75601cf907
This commit is contained in:
Kenny Johnston 2017-01-23 10:38:19 -06:00
parent 5480e3dc4c
commit 031e5db970
25 changed files with 110 additions and 112 deletions

View File

@ -20,11 +20,11 @@ software. Even more so in free open-source projects. Having a simple place for
operators to go to acquire the collective community knowledge on a given topic
will significantly reduce the barrier to entry to utilizing OpenStack.
Use Cases
---------
Requirements Specification
--------------------------
User Stories
++++++++++++
Use Cases
+++++++++
This section utilizes the `OpenStack UX Personas`_.
* As `Rey the Cloud Operator`_, I want to be able to quickly find reliable

View File

@ -63,11 +63,11 @@ Cloud service providers want to support bare metal machine, but it is a tough
challenge to provide IaaS access to bare metal with the same elastic and
service-oriented properties as they do with virtual machines.
Use Cases
---------
Requirements Specification
--------------------------
User Stories
++++++++++++
Use Cases
+++++++++
* BMT001 - As an Enterprise user, I want to use bare metal machine so that I
get consistent performance not affected by another machine, nor impacted

View File

@ -71,11 +71,11 @@ of resources for future usage. In particular:
.. * Further examples may be added by other stakeholders.
Use Cases
---------
Requirements Specification
--------------------------
User Stories
++++++++++++
Use Cases
+++++++++
.. This section is mandatory. You may submit multiple
.. user stories in a single submission as long as they are inter-related and can be
.. associated with a single epic and/or function. If the user stories are
@ -323,4 +323,3 @@ Glossary
* **CSP** - Cloud service provider
* **VNFD** - Virtual Network Function (VNF) Descriptor describes resource
requirements for VNFs

View File

@ -23,11 +23,11 @@ One of the largest barriers to adoption of OpenStack is perceived complexity.
This surfaces in attempting to understand and properly set configurations
on initial deployment, and again after upgrading.
Use Cases
---------
Requirements Specification
--------------------------
User Stories
++++++++++++
Use Cases
+++++++++
This section utilizes the `OpenStack UX Personas`_.
* As `Rey the Cloud Operator`_, I should be able to understand how to use a configuration

View File

@ -67,11 +67,11 @@ applications which have some combination of:
* Performance requirements that are met by packing related workloads; or
* Resiliency requirements that are met by spreading related workloads
Use Cases
---------
Requirements Specification
--------------------------
User Stories
++++++++++++
Use Cases
+++++++++
* As a communication service provider, I want to deploy a highly available
IMS core as a Virtual Network Function running on OpenStack so that I meet my

View File

@ -47,11 +47,11 @@ upgrade issues. This ensures that historical records of deleted items are not
impacting operational performance and such deleted items are not polluted by
upgrades.
User Cases
----------
Requirements Specification
--------------------------
User Stories
++++++++++++
Use Cases
+++++++++
This section utilizes the `OpenStack UX Personas`_.
* As `Rey the Cloud Operator`_, I need an ability to remove records of

View File

@ -49,11 +49,11 @@ issues involved in deploying in OpenStack any scalable Telco-grade control
plane Virtual Network Function (VNF) deployed as a series of load-balanced
stateless N+k pools.
Use Cases
---------
Requirements Specification
--------------------------
User Stories
++++++++++++
Use Cases
+++++++++
* As a communication service provider, I want to deploy a highly available,
high scale, high performance virtual IMS core on OpenStack to provide my core

View File

@ -37,11 +37,11 @@ OpenStackClient usability studies in both Austin and Barcelona that it took
time to learn the command structure. However, they were able to efficiently
use the client once they became familiar with the structure.
Use Cases
---------
Requirements Specification
--------------------------
User Stories
------------
Use Cases
+++++++++
These user stories utilize the standard `OpenStack UX Personas`_.
* As `Rey the Cloud Operator`_, I would like to quickly learn commands and

View File

@ -32,11 +32,11 @@ Opportunity/Justification
+++++++++++++++++++++++++
None.
Use Cases
---------
Requirements Specification
--------------------------
User Stories
++++++++++++
Use Cases
+++++++++
* As the Enterprise IT Manager, I must ensure the appropriate security for the
HR Department database containing employee records that services several
applications. I would like to migrate the database into our company's

View File

@ -21,11 +21,11 @@ Opportunity/Justification
+++++++++++++++++++++++++
None.
Use Cases
---------
Requirements Specification
--------------------------
User Stories
++++++++++++
Use Cases
+++++++++
This section utilizes the `OpenStack UX Personas`_.
* As `Rey the Cloud Operator`_, I want to be able to access a configuration description that I

View File

@ -26,11 +26,11 @@ The configuration and use of OpenStack services can be simplified by:
* documenting their completeness, maturity and documentation against specific
configuration sets
Use Cases
---------
Requirements Specification
--------------------------
User Stories
++++++++++++
Use Cases
+++++++++
This section utilizes the `OpenStack UX Personas`_.
* As `Rey the Cloud Operator`_, I want to understand what features are complete,

View File

@ -43,8 +43,8 @@ and is actively considering open-sourcing parts of it, based on requests from
its Private Cloud customers. The new Watcher project within OpenStack is also
an attempt to address some aspects of this problem.
Use Cases
---------
Requirements Specification
--------------------------
Use Cases
+++++++++

View File

@ -39,11 +39,11 @@ Opportunity/Justification
Many enterprise customers require highly available VMs in order to satisfy their
workload SLAs. For example, this is a critical requirement for NTT customers.
Use Cases
---------
Requirements Specification
--------------------------
User Stories
++++++++++++
Use Cases
+++++++++
As a cloud operator, I would like to provide my users with highly available
VMs to meet high SLA requirements. There are several types of failure

View File

@ -74,11 +74,11 @@ utilising a fast data plane or high scale SIP. The use case focuses on those
elements rather than more generic issues like orchestration and high
availability (HA).
Use Cases
---------
Requirements Specification
--------------------------
User Stories
++++++++++++
Use Cases
+++++++++
* As a communication service provider, I want to deploy a highly available,
high scale, high performance Session Border Controller on OpenStack to police
@ -257,4 +257,3 @@ Glossary
**DPDK**
Data Plane Development Kit - a set of libraries and drivers for fast packet
processing.

View File

@ -70,11 +70,11 @@ over resource sprawl. A second benefit will be that clouds running at
scale will operate more efficiently due to clean up older database
records associated with instances.
Use Cases
---------
Requirements Specification
--------------------------
User Stories
++++++++++++
Use Cases
+++++++++
.. This section is mandatory. You may submit multiple
.. user stories in a single submission as long as they are inter-related and can be
.. associated with a single epic and/or function. If the user stories are

View File

@ -76,11 +76,11 @@ OpenStack to manage new applications.
Support for onboarding legacy environments in a non-disruptive manner
will greatly increase the adoption of OpenStack.
Use Cases
---------
Requirements Specification
--------------------------
User Stories
++++++++++++
Use Cases
+++++++++
.. This section is mandatory. You may submit multiple
.. user stories in a single submission as long as they are inter-related and can be
.. associated with a single epic and/or function. If the user stories are

View File

@ -42,11 +42,11 @@ and each deployment. Currently operators are doing these extended tests
by themselves and not collaborating and taking advantage of each other.
Use Cases
---------
Requirements Specification
--------------------------
User Stories
++++++++++++
Use Cases
+++++++++
This section utilizes the `OpenStack UX Personas`_.

View File

@ -40,11 +40,11 @@ their interoperability requirements. Configuration information requested is
similar to the one that many benchmarking groups, like TPC and SPEC, provide
with their results.
Use Cases
---------
Requirements Specification
--------------------------
User Stories
++++++++++++
Use Cases
+++++++++
This section utilizes the `OpenStack UX Personas`_.
* Private Cloud

View File

@ -22,11 +22,11 @@ of the IT infrastructure for different people/positions in the organization.
Enterprise security requires separate access UI/ API for Network, Security,
Storage management, User Management, and Instance management.
Use Cases
---------
Requirements Specification
--------------------------
User Stories
++++++++++++
Use Cases
+++++++++
* As a cloud operator I want to enable my team to be able to see all Admin
level alerts, but not to be able to change their status. That requires review
and approval by the IT manager.

View File

@ -29,11 +29,11 @@ This is an inherently un-cloudy characteristic of the OpenStack platform.
Fixing upgrades and updates would clear up many concerns which limit OpenStack
adoption today.
Use Cases
---------
Requirements Specification
--------------------------
User Stories
++++++++++++
Use Cases
+++++++++
This section utilizes the `OpenStack UX Personas`_.
* As `Quinn the Application Developer`_, I want to experience a stable, regularly updated and

View File

@ -22,11 +22,11 @@ This user story is valuable to cloud operators because it allows them to tune
the scheduler without having to run the configurations in real world
environments.
Use Cases
---------
Requirements Specification
--------------------------
User Stories
++++++++++++
Use Cases
+++++++++
This section utilizes the `OpenStack UX Personas`_.
* As `Rey the Cloud Operator`_, I want to be able to simulate my cloud's scheduler with

View File

@ -17,11 +17,11 @@ Opportunity/Justification
+++++++++++++++++++++++++
TBD.
Use Cases
---------
Requirements Specification
--------------------------
User Stories
++++++++++++
Use Cases
+++++++++
* As an Enterprise IT security policy maker, I need to ensure that all compute
resources must adhere to the security policy as defined by the IT security
department so that the cloud resources are compliant to enterprise rules and

View File

@ -31,11 +31,11 @@ Opportunity/Justification
Separation of DMZ and MZ is a common requirement of VNFs to meet
communication service provider security requirements.
Use Cases
---------
Requirements Specification
--------------------------
User Stories
++++++++++++
Use Cases
+++++++++
Current Situation
-----------------

View File

@ -60,11 +60,11 @@ Opportunity/Justification
None.
Use Cases
---------
Requirements Specification
--------------------------
User Stories
++++++++++++
Use Cases
+++++++++
.. This section is mandatory. You may submit multiple
.. user stories in a single submission as long as they are inter-related and can be
.. associated with a single epic and/or function. If the user stories are

View File

@ -49,22 +49,22 @@ Opportunity/Justification
None.
Use Cases
---------
Requirements Specification
--------------------------
User Stories
++++++++++++
.. This section is mandatory. You may submit multiple
.. user stories in a single submission as long as they are inter-related and can be
.. associated with a single epic and/or function. If the user stories are
.. explaining goals that fall under different epics/themes then please complete a
.. separate submission for each group of user stories. Please replace "None." with
.. the appropriate data.
Use Cases
+++++++++
.. This section is mandatory. You may submit multiple use cases in a single
.. submission as long as they are inter-related and can be associated with a
.. single epic and/or function. If the use cases are explaining goals that
.. fall under different epics/themes then please complete a separate submission
.. for each group of use cases. Please replace "None." with the appropriate
.. data.
.. Please provide a unique three character reference and three digit number for
.. each user story
.. each use case
.. A list of user stories targeted at OpenStack UX Personas, ideally in this
.. A list of use cases targeted at OpenStack UX Personas, ideally in this
.. or a similar format:
.. * XXX### As `<type of user>`_, I want to <goal> so that <benefit>
@ -79,9 +79,9 @@ None.
Usage Scenario Examples
+++++++++++++++++++++++
.. This section is mandatory.
.. In order to explain your user stories, if possible, provide an example in the
.. In order to explain your use cases, if possible, provide an example in the
.. form of a scenario to show how the specified user type might interact with the
.. user story and what they might expect. An example of a usage scenario can be
.. use case and what they might expect. An example of a usage scenario can be
.. found at http://agilemodeling.com/artifacts/usageScenario.htm of a currently
.. implemented or documented planned solution. Please replace "None." with the
.. appropriate data.
@ -103,7 +103,7 @@ Acceptance Criteria
.. focused experience and in some cases references to types of specific
.. artifacts.
.. Please reference the user stories by three character and three number
.. Please reference the use cases by three character and three number
.. references defined above.
.. Ex. ABC123 - All Interop Projects obtain tag "FOO"
@ -123,7 +123,7 @@ None.
++++++++++++++
.. This section is optional. It might be useful to specify
.. additional requirements that should be considered but may not be
.. apparent through the user story and usage examples. This information will help
.. apparent through the use cases and usage examples. This information will help
.. the development be aware of any additional known constraints that need to be met
.. for adoption of the newly implemented features/functionality. Use this section
.. to define the functions that must be available or any specific technical