ShaftHQ / shafthq.github.io

SHAFT_Engine's official user guide, powered by Docusaurus 3.x

Home Page:https://shafthq.github.io/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

enhance onboarding user flow

MohabMohie opened this issue · comments

  • New users want to be onboarded properly. We lose a lot of potential users because our onboarding docs are too technical and not user friendly enough.
  • Instead of linking to GitHub, we should figure out a way to show a parsed version of the github readme inside the user guide itself, this will ensure cross updates and will allow the users to remain on one main website.
  • New users want to have clear steps to setup a new project along with all the needed p1 properties:
    • Web
    • Mobile
    • API
  • New users want to have clear steps to setup a new Web project using the three different runners we support:
    • TestNG
    • JUnit5
    • Cucumber
  • Following the less is more approach we want the user to get a sense of progression when they are getting started.
    • We can split the getting started guide from one single scrollable page to multiple wizard-like small pages.
    • we can leverage Next / Previous / Footer links (breadcrumbs) to ensure easy flow.
    • we can make sure that the user gets all the needed information sequentially, in one place, and without many options.
  • New users want to have clear guidance on our support channels:
    • We can list them in a separate page
  • New users want to have clear guidance on the types on integrations we support:
    • Jira
    • Xray
    • BrowserStack
    • LambdaTest
    • OpenCV
    • ShutterBug
    • Healenium
    • Slack (was requested)
    • Microsoft Teams (was requested)