Documentation

Welcome to the documentation for Tutor Platform! This guide will help you understand how to use our platform effectively, whether you're a tutor creating exams or a student taking them.

Key Features

• For Tutors: Create exams, manage questions, invite students, and analyze results
• For Students: Take exams, review results, and track progress over time
• Powerful Analytics: Get detailed insights into student performance
• User-Friendly Interface: Intuitive design for both tutors and students

To get started, either register as a tutor or take an exam as a student.

As a tutor, you can create exams with various question types, set time limits, and share them with your students. Here's how to get started:

1. Log in to your tutor account

   Use your credentials to log in through the login page.

2. Navigate to the Dashboard

   After logging in, you'll be redirected to your tutor dashboard where you can see an overview of your exams, students, and analytics.

3. Create a New Exam

   Click on the "Create Exam" button in the dashboard to start creating a new exam. You'll need to provide a title, description, time limit, and other settings.

4. Add Questions

   Add multiple-choice, true/false, or open-ended questions to your exam. You can also add images or diagrams to questions.

5. Publish and Share

   Once your exam is ready, publish it and share the unique link with your students.

The Question Bank is a powerful feature that allows you to create, store, and reuse questions across multiple exams, saving you time and effort.

How to Use the Question Bank

1. Access the Question Bank

   Navigate to the "Question Bank" section from your tutor dashboard by clicking on the "Question Bank" link in the sidebar menu.

2. Create Categories

   Organize your questions by creating categories based on subjects, topics, difficulty levels, or any other classification that suits your needs.

3. Add Questions

   Click the "Add Question" button to create new questions in your Question Bank. These questions are stored independently of any specific exam.

4. Import Questions to Exams

   When creating or editing an exam, click the "Import from Question Bank" button to select and import questions from your bank.

5. Save Questions to Bank

   When creating questions directly in an exam, you can check the "Save to Question Bank" option to simultaneously add it to your Question Bank for future use.

Fig 2: The Question Bank interface showing categories and questions

Benefits of the Question Bank

Our platform allows you to organize exam questions into sections, making it easier to create structured exams with distinct topics or difficulty levels.

Working with Exam Sections

1. Create Exam Sections

   When creating or editing an exam, click the "Add Section" button to create distinct sections within your exam (e.g., "Basic Concepts", "Advanced Problems", "Essay Questions").

2. Configure Section Properties

   For each section, you can define a title, description, and specific instructions for students to follow for that particular group of questions.

3. Add Questions to Sections

   When adding questions to your exam, you can assign each question to a specific section. Only questions assigned to a section will appear in that section of the exam.

4. Reorder Sections

   Drag and drop sections to change their order within the exam. This affects the sequence in which students will encounter different parts of the exam.

5. Section-Specific Settings

   Optionally configure section-specific settings like time limits, scoring, or whether students can navigate between questions within a section.

Fig 2: Exam creation interface showing section organization

Benefits of Using Exam Sections

You can invite students to take your exams and track their progress:

• Invite Students

  You can invite students via email or by sharing a unique link. Students will be prompted to create an account if they don't have one.

• Monitor Progress

  Track which students have started or completed the exam, and see their results in real-time.

• Review Results

  After students complete an exam, you can review their answers, provide feedback, and generate detailed reports.

Our platform includes several security features to help maintain academic integrity during exams:

Basic Security Features

Advanced Proctoring Options

For high-stakes exams, you can enable advanced proctoring features:

Proctoring Review

After an exam with proctoring enabled:

1. Access the "Proctoring Review" panel from the exam results page
2. View flagged incidents that the system detected as potentially suspicious
3. Review webcam recordings and screenshots from these incidents
4. Make informed decisions about exam validity based on the evidence

As a student, you can take exams created by your tutors. Here's how:

1. Access the Exam

   Use the link provided by your tutor to access the exam. You may need to create an account or log in if you already have one.

2. Read Instructions

   Before starting, read the exam instructions carefully, including the time limit and any specific guidelines.

3. Answer Questions

   Answer each question to the best of your ability. You can navigate between questions using the navigation panel.

4. Submit Your Exam

   Once you've answered all questions, review your answers and submit your exam before the time expires.

5. View Results

   Depending on the settings, you may be able to see your results immediately or after your tutor reviews your answers.

Our exam platform includes several features to enhance your exam-taking experience:

Navigation and Progress Tracking

The exam interface includes a navigation panel that shows:

• All questions in the exam, with visual indicators for answered and unanswered questions
• Flagged questions for easy access
• Your overall progress (percentage of questions answered)
• Section divisions (if the exam is organized into sections)

Here's how to manage your student account:

• Update Profile

  Keep your profile information up to date, including your name, email, and profile picture.

• View Exam History

  Access your exam history to see all the exams you've taken, along with your scores and feedback.

• Communicate with Tutors

  Use the messaging feature to communicate with your tutors if you have questions or need clarification.

We've created a comprehensive video tutorial to help you understand how to use our platform efficiently. This video covers both tutor and student features.

Accessing the Video Tutorial

The video tutorial can be accessed from the homepage by clicking on the blue help button in the bottom right corner of the screen. This will open a popup window with the tutorial video.

Fig 1: Help button location on the homepage

Using the Video Controls

The video player includes several controls to enhance your viewing experience:

• Play/Pause

  Click the play button to start the video or pause it at any time.

• Progress Bar

  The progress bar shows how much of the video you've watched. You can click anywhere on the bar to jump to a specific part of the video.

• Volume Control

  Adjust the volume or mute the video using the volume control.

• Fullscreen

  Click the fullscreen button to watch the video in fullscreen mode.

Video Content Overview

The video tutorial covers the following topics:

1. Introduction (0:00 - 1:30): Overview of the platform and its key features
2. Tutor Features (1:31 - 5:00): Creating exams, managing questions, and inviting students
3. Student Features (5:01 - 8:30): Taking exams, reviewing results, and tracking progress
4. Advanced Features (8:31 - 12:00): Analytics, reports, and customization options
5. Troubleshooting (12:01 - 15:00): Common issues and how to resolve them

Our platform integrates MathJax to allow you to create beautiful mathematical expressions using LaTeX syntax. This is especially useful for creating questions in science, engineering, and mathematics subjects.

Basic LaTeX Syntax

To include mathematical expressions in your questions, you can use LaTeX syntax enclosed within special delimiters:

Common Mathematical Expressions

Here are some common mathematical expressions you can use:

Our platform provides a floating Math Tools panel that makes it easier to insert mathematical expressions without having to remember LaTeX commands.

Accessing the Math Tools Panel

When editing or creating a question, you can access the Math Tools panel in several ways:

1. Using the Button

   Click the Math Tools button in the question editor.

2. Using Keyboard Shortcut

   Press Ctrl + M to show or hide the Math Tools panel.

Fig 1: The Math Tools panel with various mathematical symbols and templates

Features of the Math Tools Panel

The Math Tools panel includes several features to help you create mathematical expressions:

• Common Symbols

  Quick access to commonly used mathematical symbols like Greek letters, operators, and relation symbols.

• Templates

  Pre-defined templates for complex structures like matrices, equations, and mathematical environments.

• Live Preview

  See a preview of how your mathematical expression will look as you type.

• Display Mode Toggle

  Switch between inline and display mode for your expressions.

Matrices

You can create matrices using different environments:

\begin{pmatrix}
a & b \\
c & d
\end{pmatrix}

Aligned Equations

For multiple equations that should be aligned:

\begin{align}
y &= x^2 + 2x + 1 \\
&= (x+1)^2
\end{align}

Chemical Equations

For chemical equations and reactions:

\ce{H2O + CO2 -> H2CO3}

Physics Equations

For physics equations with vectors and units:

\vec{F} = m\vec{a}

Our platform supports several types of questions to accommodate different assessment needs:

General Guidelines

• Be Clear and Concise

  Write questions that are easy to understand, avoiding ambiguous wording.

• Use Consistent Notation

  Maintain consistent mathematical notation throughout your exam.

• Preview Your Questions

  Always use the preview feature to check how your questions will appear to students.

• Include Units When Necessary

  For questions involving measurements, clearly specify the required units.

For Mathematical Questions

1. Break Down Complex Expressions

   For complicated mathematical expressions, build them step by step and verify each part.

2. Use Display Mode for Complex Formulas

   For complex mathematical expressions, use display mode ($$...$$) to make them more readable.

3. Include Visual Representations

   When possible, include graphs, diagrams, or visual representations to complement mathematical concepts.

4. Test with Different Screen Sizes

   Ensure your mathematical expressions display correctly on both desktop and mobile devices.

To speed up your question creation process, you can use these keyboard shortcuts:

Specific Issues and Their Solutions

Advanced Troubleshooting Steps

If you couldn't find the answer to your question in this documentation, please contact our support team: