For any contributors who would like to edit the VNF Requirements document.

The enhanced toolkit that we are proposing has been developed to help users edit the VNF Requirements documents in a quicker fashion, as well as adding more functional capabilities of the this project. Outlined in this document are the added tools we are proposing:

Current Process Flow

1. All Requirements manually maintained within RST files.

   1. For example:
      

      **Resource Description**
      -------------------------
      * R-77707 The VNF provider **MUST** include a Manifest File that contains a list of all the components in the VNF package.
      * R-66070 The VNF Package **MUST** include VNF Identification Data to uniquely identify the resource for a given VNF provider. The identification data must include: an identifier for the VNF, the name of the VNF as was given by the VNF provider, VNF description, VNF provider, and version.
      * R-69565 The VNF Package **MUST** include documentation describing VNF Management APIs. The document must include information and tools for:
      
      

2. No additional information about individual requirements is maintained.

   1. For example:
      
      1. Release
      2. Testable
      3. etc.
         
         

3. Requirements must be manually updated in multiple locations within the RST files.

   1. Requirements must be managed within the proper Chapter and Section, AS WELL AS within the Appendix.

Proposed Process Flow

1. All Requirements are maintained as JSON Formatted in one document.

   1. For example:

      "R-01334": {
              "description": "The VNF **MUST** conform to the NETCONF RFC 5717, Partial Lock Remote Procedure Call.", 
              "id": "R-01334", 
              "section": "Configuration Management",
              "requirement target": "VNF",
              "definedRFC2119 keyword": "MUST"
          }

2. Metadata Retained for each Requirement

   1. Current fields within metadata with possible fields:
      1. description
         1. Any string describing the requirement.
      2. id
         1. Number of the requirement formatted as an 'R-' followed by 5 numbers, must be unique : "R-XXXXX"
      3. section
         1. Proposed section values:
            1. Configuration Management
            2. Management
            3. Monitoring & Management
            4. VNF Design
            5. VNF Devops
            6. VNF Modularity
            7. VNF On-boarding and package management
            8. VNF Resiliency
            9. VNF Security
         2. Option to add a new section as well.
      4. requirement target/component/subject (final field name not decided)
         
         1. Proposed field values:
            1. VNF
            2. PNF
            3. xNF
            4. VNF-c
            5. VNF Package
            6. VNF Heat Template
      5. defined RFC2119 keyword
         
         1. Proposed field values:
            1. MUST
            2. SHOULD
            3. MUST NOT
               
               

3. RST ↔JSON Linking to simplify number of locations that need to be managed

   1. For example:
      

      **Resource Description**
      -------------------------------------------
      
      R-77707
      R-66070
      R-69565