Skillsetter Style Guide

Overview

About

Last updated: 2023/05/16

Framework: Bootstrap v4.3.1

This document is a guide for how the front-end of https://www.skillsetter.com should look and be written. This guide is not meant to be static and should be updated regularly.

Design Principles

Design principles are agreed upon philosophies about how the ideal user experience should be applied to the Skillsetter UI.

Simplicity

Keep the system simple and easy to use for all types of users. Users should be able to complete tasks intuitively, even if help pages or additional instructions are provided.

Consistency

Aim for consistency in design and keep special cases to a minimum.

Kaizen

For new features, the MVP should be considered first. Improvements should build on top of the MVP one at a time, avoiding large changes when possible.

Glossary

Format:
  • Word: Definition.
    •
    • Course: An encompassing container for a class. See Courses
    • Evaluation: A grading of a response according to a rubric.
    • Evaluator: Not a specific user role, but can be any user that marks responses. Can be an instructor, TA, or student in the same group as the one that submitted the response.
    • Group/Student Group: Defined at the course level, student groups are designated evaluators of each other's responses.
    • Model Response: A response to a practice case that the instructor has marked as a model. This means that everyone in the course can see that response video, but not any evaluations for it. Requires approval to be marked as a response if the video was not created by the instructor.
    • Module: A container inside a course. See Modules
    • Note: A type of module item consisting of text only. Instructors create them for students to read.
    • Practice Case: A type of module item that provides a stimulus video and allows students to submit a response. See Practice Cases
    • Response: A video recorded by a student in response to a Practice Case's Stimulus Video.
    • Rubric: A set of questions a student must answer to self-evaluate before submitting a response. The evaluator follows the same set of questions.
    • Stimulus Video: Videos created by Skillsetter that simulate a theoretical client's therapy session. The primary component in Practice Cases.

    User Roles

    Format:
  • Word: Definition.
    •
    • Course Creator/Course Builder: A special role that can build courses for an institution. Not usually instructors.
    • Course Owner: Often (but not always) synonymous with instructor. A course owner is the main admin of a course.
    • Instructor: Often synonymous with course owner. An instructor is the main admin of a course on Skillsetter. It is possible for a user to be both an instructor and a student. There is no role distinction between instructors and researchers.
    • Participant: Enrolled in a course being used for research purposes. There is no role distinction between participants and learners.
    • Researcher: Is the main admin of a course on Skillsetter for research purposes. There is no role distinction between instructors and researchers.
    • Learner: A user on Skillsetter that is enrolled in a course on Skillsetter. It is possible for a user to be both an instructor and a learner. There is no role distinction between participants and learners.
    • Assistants: Users able to evaluate any response in the course they are assisting in.