Uploaded image for project: 'ONAP TSC'
  1. ONAP TSC
  2. TSC-54

TSC "Must Have" Dublin Requirements - Documentation

XMLWordPrintable

      Creation of an Use Case Template Leaflet including the use case definition, architecture diagram, development implementation, configuration and prerequisites, test cases and test results, user guide etc.

      If an Use Case Leaflet is incomplete by RC2 then the use case will be postponed to the next release

       

      Additional needs from a documentation’s perspective:

      • Another area to improve is the wiki – onboard new developer/tester – what do they need to know?
      • Explanation of the Core ONAP components
      • Welcome package –targeting different audience (consumer, ops, tester, dev. etc.)

       

      Is there a way to get it back earlier in the release?

      “Document what you do” – part of the acceptance criteria related to the use case.

      Reduce the documentation effort at the end of the release by adding it as a milestone checkpoint and define the scope of the milestone in alignment with what is ready i.e.

      M1 use case definition, HLD, epics, user stories, step by step process, E2E flows including interaction details about cross-components.

      M2-detailed implementation and test cases/ test results expected

      Etc.

      Maybe learn from Openstack/K8S documentation/guidelines

      Task Force: Sofia (Doc PTL), Use Case Owners (including Davide-CCVPN), Gildas and Catherine

            sofiawallin sofiawallin
            katel34 katel34
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: