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

SKAMPI User documentation for new users

Details

    • Enabler
    • Must have
    • PI11
    • None
    • Obs Mgt & Controls
    • Hide

      There is a lot of hesitancy from new users on how to get SKAMPI up and running. And often, the knowledge on how to do that is passed within teams. With a 'quick start' guide in the developer portal, those instructions can be formalised & harmonised across the train.

      Show
      There is a lot of hesitancy from new users on how to get SKAMPI up and running. And often, the knowledge on how to do that is passed within teams. With a 'quick start' guide in the developer portal, those instructions can be formalised & harmonised across the train.
    • 2
    • 2
    • 2.5
    • Team_ATLAS
    • Sprint 4
    • Hide
      • Steps of getting deployment running were added to the Documentation and new README
      • Prerequisites are all listed
      • Links to external and other documentation were added and tested
      • Introduction explains what SKAMPI can/can't do
      • the simple git clone paragraph added helped "finding" SKAMPI for someone already reading the docs, but the problem of finding the documentation persists
      • Where to get help documented in a useful manner
      • The need for explaining how to contribute to the documentation (that was expressed in INS-15) was not addressed in this Enabler, nor was it planned as part of the scope for this work. It is still something that needs to be addressed, and was clearly showcased by the Survey results and risk-raising that clear ownership of the project is lacking.
      • The hope that people will go and read documentation simply because it exists is unfounded. The onus of socialisation of the new documentation will have to remain largely with the social structures provided by SAFe (Sync meetings, Team standups, etc). This was an insight gathered at the Problem Solving Workshop, after the demo showcased newly available documentation.
      Show
      Reorganised doc structure visible on landing page of SKAMPI docs: https://developer.skao.int/projects/ska-skampi/en/latest/index.html Clicking on "Getting Started" on above page takes a reader to the Quick Start Guide, which is also the README which is open when going to https://gitlab.com/ska-telescope/ska-skampi Demo slides: https://docs.google.com/presentation/d/1Esdz99v6kxD0H2tuFcNrmibXbyxAZxh8AV6xoZ1XYco/edit? User Survey results: https://docs.google.com/forms/d/e/1FAIpQLSc8_7gPBGL5hmZnj-LyBsaHB4UdPzBhtuqPNYtG1k_exJsB1w/viewanalytics Steps of getting deployment running were added to the Documentation and new README Prerequisites are all listed Links to external and other documentation were added and tested Introduction explains what SKAMPI can/can't do the simple git clone paragraph added helped "finding" SKAMPI for someone already reading the docs, but the problem of finding the documentation persists Where to get help documented in a useful manner The need for explaining how to contribute to the documentation (that was expressed in INS-15) was not addressed in this Enabler, nor was it planned as part of the scope for this work. It is still something that needs to be addressed, and was clearly showcased by the Survey results and risk-raising that clear ownership of the project is lacking. The hope that people will go and read documentation simply because it exists is unfounded. The onus of socialisation of the new documentation will have to remain largely with the social structures provided by SAFe (Sync meetings, Team standups, etc). This was an insight gathered at the Problem Solving Workshop, after the demo showcased newly available documentation.
    • 11.6
    • Stories Completed, Integrated, Solution Intent Updated, BDD Testing Passes (no errors), Outcomes Reviewed, NFRS met, Demonstrated, Satisfies Acceptance Criteria, Accepted by FO
    • PI22 - UNCOVERED

    • ux

    Description

      As a new user of SKAMPI, I want an easy to understand document/webpage that will allow me to get started using SKAMPI.

       

      SKAMPI is becoming quite large, and it's hard for a new user to find:

      • what SKAMPI can/can't do
      • what the user needs to install on their machine to get it to work
      • where to 'get' SKAMPI, and how to install it
      • how to check whether all of the necessary components are running
      • typical problems and troubleshooting steps
      • where to get help when problems cannot be resolved simply ("after an hour, who do I call/where do I go?")

       

      Attachments

        Issue Links

          Structure

            Activity

              People

                p.klaassen Klaassen, Pamela
                v.mohile Mohile, Vivek
                Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Feature Progress

                  Story Point Burn-up: (93.42%)

                  Feature Estimate: 2.0

                  IssuesStory Points
                  To Do00.0
                  In Progress   10.5
                  Complete97.1
                  Total107.6

                  Dates

                    Created:
                    Updated:
                    Resolved:

                    Structure Helper Panel