Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: expanded section on requirement identifiers

...

The  Project Charter also mentions the development of "EPIC statements". The ONAP JIRA wiki uses the term User Story Syntax  for the same structure:

User Story Syntax

As a <user> = who
I want to <be able to do ABC> = what
So that <XYZ can be done> = why

The  requirements from the seed document are not in this form, and so some task would be required to structure them appropriately 

...

  • Requirements as text in a .hmtl formatted  VNF Requirements deliverable for use in RFPs  - EPICVNFRQTS-6
  • Requirements as  table for conformance mapping - User StoryVNFRQTS-27
  • Correlate VNF Requirements and VNF test cases for validation - EPIC - VNFRQTS-8 
  • Subsets of the requirements apply for particular conformance mapping activities beyond complete VNFS e.g. 
    • VNF Requirements impacting the VNF Package definition - User Story -  VNFRQTS-28
    • VNF Requirements for configurable parameters - User Story -  VNFRQTS-28

Requirement

...

Requirements should be uniquely identified.

Requirement attributes

Attributes may be required to support subsetting  the list of requirements.

...

Tooling is needed to extract just the requirements sentence from the table format.  This is expected to require the VNF requirements to be tagged appropriately in the ,rst source files

Requirement identifiers

Requirements should be uniquely identified.

Currently structured as single sentences starting with R-XXXX (allows for searching, extraction from narrative text). 

Numbering semantics: Yes/No 

no semantics: implies a random number/ string as an identifier.  Requires a tool of some sort to generate these random numbers. Requires some process for contributors/ editors to aquire and use these random numbers

yes semantics: e.g. sequential, chapter sequential, sequential with spaces etc. 

How many digits:

Currently ~300 numbered requirements in the seed documents, but  some seed material did not have requirements explicitly numbered. 

suggest 5 digits allows plently of room for expansion/ revision / retirement.  

Number of digitis could be changed in a future release if needed. 

Application for Amsterdam. 

M4 is 9/14 so tool chain changes at this stage might be problematic.

could  manually apply numbers  for this release and consider other mechanisms in future?

could investigate sequential numbering mechanisms in Sphinx etc.