Uploaded image for project: 'SAFe Program'
  1. SAFe Program
  2. SP-698

Design documentation for the SDP MVP

Change Owns to Parent OfsSet start and due date...
    XporterXMLWordPrintable

Details

    • Feature
    • None
    • COM SDP SW
    • None
    • Data Processing
    • Hide

      Maintaining an up to date view of the current implementation of the Data Processing SDP MVP (currently in the sdp-prototype repo) is important to be able to communicate the current state of the solution, and to help inform new and existing developers who are contributing to this code base.

      Show
      Maintaining an up to date view of the current implementation of the Data Processing SDP MVP (currently in the sdp-prototype repo) is important to be able to communicate the current state of the solution, and to help inform new and existing developers who are contributing to this code base.
    • Hide

      Initial design documentation for the DP SDP MVP (sdp-prototype repo) including:

      • A description of the structure and behaviour different services and controllers
      • A description of the structure and behaviour of a basic workflow
      Show
      Initial design documentation for the DP SDP MVP (sdp-prototype repo) including: A description of the structure and behaviour different services and controllers A description of the structure and behaviour of a basic workflow
    • 2
    • 4
    • 4.6
    • PI24 - UNCOVERED

    Description

      Create initial version of design documentation to compliment the 'getting started guide' (SP-641) targeted towards developers working on the data processing evolutionary prototype.

      This should include (but not necessarily be limited to):

      • A description of how the different services and controllers work together
      • A description of how errors and failures propagate
      • A description of how workflows are developed and integrated

      This documentation should be maintained alongside the code and be placed under revision control such that it can be easily referred to and and updated as the code evolves.

      Where possible, it should be linked (both ways) to the relevant architecture documents so that it provides traceability between the high-level intended architecture and current implemented solution. As the relevant architecture documentation may not yet in a form that supports this traceability, the team developing documentation should stay in close communication with the DP Architect, so that they are up to date with how the SKA Solution Intent is being managed.

      As this is a strictly time-boxed activity however, and is expected to evolve in future PIs along with the code, if full traceability to architecture documents is not possible documenting the current implementation should take priority over the practices of SKA Solution Intent.

      Attachments

        Issue Links

          Structure

            Activity

              People

                j.santander-vela Santander-Vela, Juande
                b.mort Mort, Ben
                Votes:
                0 Vote for this issue
                Watchers:
                0 Start watching this issue

                Feature Progress

                  Story Point Burn-up: (0%)

                  Feature Estimate: 2.0

                  IssuesStory Points
                  To Do00.0
                  In Progress   00.0
                  Complete00.0
                  Total00.0

                  Dates

                    Created:
                    Updated:
                    Resolved:

                    Structure Helper Panel