User Story - Program tutorial

[Alex-x90]

Motivation

As a more casual user I want an introduction to the program so I can use it for the first time and watch an interesting simulation of some organisms.

Background

For new users that are unfamiliar with the program it will be challenging to pick up without some type of guide through the functionality. We want the program to be user friendly so that users are able to quickly start using it and won't be off-put or confused.

Requirements

• Built in tutorial of basic functionality.
• Help menu with more in-depth information.

Dependencies

• UI is defined and in a final state.
• All documentation is up to date.

Estimate

Initial estimate of 4-8 hours. The in depth help will evolve as other work is done, so ideally should be set up in a way it won't need additional work.

Open Questions

• Does a built in tutorial make sense vs. linking a setup guide/beginner guide, or making a setup video?
• Where should a help menu go?
• Should the help menu be it's formulated thing, or could/should it just interpret the documentation?

Acceptance Criteria

• All documentation is in an appropriate state to be used by an outside user.
• All implemented features have documentation coverage.
• PR is reviewed & approved by at least one project member besides PR author.
• User should be able to learn the basics of the program in under 10min (subject to change as program complexity changes).

Definition of done

• Acceptance criteria are met.
• All Unit & Integration testing passes.
• Documentation and release notes are updated.
• PR merged to main