Skip to content

User Documentation

ryanarndtsen edited this page Dec 6, 2019 · 21 revisions

User Documentation for Quality Academy

The user documentation described will be exclusively for the manager viewpoint, and therefore only pertains to functionalities that are accessible by managers. The mobile application will be deployed only for Android devices.

Features

Login

alt text

Once the application is opened for the first time, Users are taken to a login page which contains two text fields, a login button, and a Create Account/ Sign Up button. On this page, users may either decide to login using credentials they possess from earlier interactions with the application (website or mobile). Further instructions below:

  • Logging in: To login to an existing account, Users must enter their email address and password into the two text fields. Once this is done, Users may press the Login button which will send them to the Quality Academy mobile home page (if credentials exist in our database).
  • Signing up: To sign up, users must click on the Create Account button below the login fields on the login page. This will send them to a Sign Up page which has fields for Name, Email address, and Password. Once all fields are entered, including a valid email address and password, Users are directed to the Quality Academy mobile home page.

Home Page

alt text

The Quality Academy mobile home page is neatly organised into a list of entities to be viewed by the user. Users may tap on any of these entities to be directed to the entity home page that they chose.

Tutors Page
alt text
The Tutors page has two buttons to pick between: "Verify Tutors" and "View Tutors".

  • View Tutors:
    alt text
    Once users direct themselves to this page, they will be able to see a list of all tutors in our database. Each element in this list contains the tutor's first name and last name (subjects, courses, description, status, phone number, email address and rating will be available in the future).
  • Verify Tutors:
    alt text
    On this page, the user is able to verify a tutor by simply inputting the tutor's corresponding account email address. This will return an error message if the tutor is already verified, or if the email answered does no correspond to a tutor in our database.

Rooms Page:
alt text
Once users direct themselves to the rooms page, they will be able to add rooms to the database. To do this, they will either implement a room number in the individual room text box or the group room text box. They will then click on the corresponding button to create the room.

Students Page:
Once users direct themselves to the students page, they will be able to see a list of all students in our database. Each element in this list contains the tutor's first name, last name, education level, phone number, email address and rating. This gallery is scroll-only, therefore users may not edit the student's profile information or status (this page will be implemented in the future).

Sessions Page:
Once users direct themselves to the sessions page, they will be able to see a list of all past, present and future scheduled sessions. These will be displayed in ascending time order by default. Each session element will show the names of all tutors and students involved, the date and time of the session, the course that will be taught and the room (this page will be implemented in the future)