Overall Flow

🚀 General Flow Guide for Teaching Machines

Welcome to Teaching Machines, an interactive educational platform designed to deliver engaging, AI-powered learning experiences. This guide provides a detailed walkthrough of the platform’s core components—Home Interface, Flow Management, Settings, Content Management, Classes Management, Admin Panel, and Customization—ensuring users of all roles (Super Admins, Organization Admins, Teachers, and Students) can effectively navigate and utilize the app. Whether you’re managing organizations, creating courses, or engaging with lessons, this guide will help you make the most of the platform.

📋 Overview of Teaching Machines

Teaching Machines is a role-based platform that supports scalable educational management and delivery. Key features include:

  • AI-Powered Teaching: An AI Teacher delivers lessons via a whiteboard, chat, and voice interactions.
  • Role-Based Access: Different permissions for Super Admins, Organization Admins, Teachers, and Students.
  • Content Creation: Tools to create courses, lessons, slides, dialogues, and quizzes.
  • Class Management: Organize students and courses into structured classes.
  • Customization: Personalize the app’s appearance and AI behavior for your organization.
  • Interactive Learning: Engage students with voice, chat, and dynamic content navigation.

This guide follows a logical flow, starting with setup (for admins) and progressing to content creation, class management, and student interactions, ensuring a seamless experience across all roles.

🏠 1. Getting Started: Home Interface

The Home Interface is the central hub for users to interact with courses, engage with the AI Teacher, and navigate content. It’s accessible to all users and serves as the entry point for learning.

Key Features

  • Course Selection: Browse and start available courses.
  • AI Teacher Interaction: Engage via chat, voice, or the “Raise Hand” feature.
  • Slide Navigation: Move through lesson slides with intuitive controls.
  • Whiteboard: View AI-driven explanations on an interactive whiteboard.

Steps to Use the Home Interface

  1. Log In:

    • Access the platform via your organization’s custom domain or the main Teaching Machines URL.
    • Enter your credentials (email and password).
    • Example: Student logs in with john.smith@testacademy.com and password.

  2. Select a Course:

    • On the Home Interface, view the list of available courses (filtered by your role and organization).
    • Click a course (e.g., “Biology Basics”) to start.
    • Expected Outcome: The AI Teacher loads the course, displaying the first slide on the whiteboard.

  3. Interact with the AI Teacher:

    • Chat: Use the chat panel (toggle with the chevron icon) to type questions (e.g., “What is a cell?”).
    • Voice: Click the microphone button to speak. Enable Voice Activity Detection (VAD) by right-clicking for hands-free interaction.
    • Raise Hand: Click the Raise Hand icon to pause the lesson and ask a question.
    • Expected Outcome: The AI responds contextually, using text or voice, based on the course content.

  4. Navigate Slides:

    • Use the Previous (⏮), Continue (⏭), and Play/Pause (▶️) buttons under the chat list to control slide progression.
    • Click the Course Content button to jump to specific courses, lessons, or slides.
    • Expected Outcome: Slides transition smoothly, and navigation reflects the selected content.

  5. Explore Additional Features:

    • Monitor real-time feedback from the AI Teacher.
    • Use the whiteboard to view diagrams, text, or videos presented by the AI.
    • Expected Outcome: The interface remains responsive, and content displays correctly across devices.

Best Practices

  • For Students: Regularly use the Raise Hand feature to clarify doubts without interrupting the lesson flow.
  • For Teachers: Preview courses in the Home Interface to ensure content displays as intended.
  • Accessibility: Enable VAD for easier voice interactions or use keyboard shortcuts for navigation.

🔁 2. Configuring AI Behavior: Flow Management

The Flow Management page, accessible to Super Admins and Organization Admins, allows you to design how the AI Teacher interacts with users through visual flow diagrams and dynamic prompts.

Key Features

  • Visual Flow Editor: Create and connect nodes to define AI behavior.
  • Dynamic Prompts: Customize system, conversation, and FAQ prompts with variables.
  • Organization Settings: Configure AI model, temperature, and navigation flows.
  • Navigation Setup: Define fixed responses for specific user queries.

Steps to Use Flow Management

  1. Access Flow Management:

    • Navigate to the Flow Management page (visible only to Super Admins and Organization Admins).
    • Expected Outcome: The visual flow editor loads with a blank canvas or existing flows.

  2. Create a Flow:

    • Click and drag to create nodes (e.g., “Start Lesson,” “Explain Concept”).
    • Connect nodes to define the sequence (e.g., “Start Lesson” → “Explain Concept” on user input “begin”).
    • Add prompts to nodes:
      • System Prompt: “Act as a biology teacher explaining cell structure.”
      • Conversation Prompt: “Welcome, {student_name}! Let’s explore cells.”
    • Drag variables (e.g., {student_name}) from the right sidebar into prompts.
    • Expected Outcome: The flow is saved, and nodes reflect the configured prompts.

  3. Configure Organization Settings:

    • Click the Settings button in the bottom-left corner.
    • Set:
      • Custom Domain: learn.testacademy.com
      • AI Model: Default model
      • Temperature: 0.75
      • Organization Navigation: Enabled
    • Expected Outcome: Settings are saved, and the custom domain is active.

  4. Set Up Navigation Responses:

    • Click the Organization Navigation Setup button.
    • Add a response:
      • Question: “What is a cell?”
      • Answer: “A cell is the basic unit of life.”
      • URL: Link to a relevant resource (e.g., a diagram).
      • Animation: “Talking”
      • Course ID: Select “Biology Basics.”
    • Expected Outcome: The navigation response is saved and triggers when the question is asked.

  5. Manage Prompt Templates:

    • In the Prompt Management section, edit templates (e.g., General Conversation).
    • Add variables or rewrite prompts to match your organization’s tone.
    • Expected Outcome: Updated prompts are applied to AI interactions.

Best Practices

  • Dynamic Variables: Use variables like {student_name} to personalize interactions.
  • Test Flows: Preview flows in the Home Interface to ensure correct behavior.
  • Clear Prompts: Write concise prompts to avoid ambiguous AI responses.
  • Access Control: Ensure only authorized admins modify flows to maintain consistency.

⚙️ 3. Personalizing Your Experience: Settings

The Settings page allows all users to customize their profile, security, and AI interaction preferences.

Key Features

  • User Information: Update personal details and view role/organization.
  • Password Management: Change your login password.
  • Personalization: Customize nickname, theme, avatar, and voice settings.

Steps to Use Settings

  1. Access Settings:

    • Navigate to the Settings page from the main menu.
    • Expected Outcome: The Settings page loads with sections for User Information, Password Information, and Personalization.

  2. Update User Information:

    • Edit:
      • First Name: “John” to “Jonathan”
      • Language: “English” to “Swahili”
    • Click Save.
    • Expected Outcome: The UI updates to Swahili, and the user’s name changes to Jonathan.

  3. Change Password:

    • Enter:
      • Old Password: Current password
      • New Password: “NewPass123456”
    • Click Save.
    • Expected Outcome: A success notification confirms the password change, and login with the new password works.

  4. Customize Personalization:

    • Set:
      • Preferred Nickname: “Johnny”
      • Theme: Dark
      • AI Avatar: Select a specific 3D model
      • Voice Recorder Type: Voice Activity Detection
      • TTS Voice: Choose a preferred voice style
      • Chat Language: Auto Detect
    • Click Save.
    • Expected Outcome: The AI addresses the user as “Johnny,” the interface uses the dark theme, and voice interactions use VAD.

Best Practices

  • Security: Use strong passwords (minimum 8 characters) and update them regularly.
  • Personalization: Choose a nickname and avatar that enhance engagement.
  • Accessibility: Select a language and theme that suit your preferences for ease of use.

📚 4. Creating Educational Content: Content Management

The Content Management section, accessible to Super Admins, Organization Admins, and Teachers, enables the creation and management of courses, lessons, slides, dialogues, and quizzes.

Key Features

  • Course Creation: Build structured courses with customizable settings.
  • Lesson Management: Create and organize lessons within courses.
  • Slide Types: Support for images, videos, quizzes, dialogues, and HTML canvas.
  • Quiz Creation: Design standard or personality-based quizzes.
  • Dialogue System: Create interactive AI-driven conversations.
  • Import/Export: Manage content with ZIP, JSON, or Excel templates.

Steps to Use Content Management

  1. Access Content Management:

    • Navigate to the Content Management section.
    • Expected Outcome: The course list loads in a table (desktop) or card (mobile) view.

  2. Create a Course:

    • Click Create Course and enter:
      • Title: “Biology Basics”
      • Type: Regular
      • Is FAQ: False
      • Tags: “biology, science, beginner”
      • Description: “Introduction to basic biology concepts.”
      • Class: “Grade 10 Science”
    • Click Save.
    • Expected Outcome: The course appears in the course list with the specified details.

  3. Add a Lesson:

    • Select “Biology Basics” and click Add Lesson.
    • Enter:
      • Lesson Name: “Cell Structure”
      • Description: “Learn about the components of a cell.”
      • Tags: “cells, biology”
    • Click Save.
    • Expected Outcome: The lesson is added to the course and appears in the expandable lesson view.

  4. Add Slides:

    • In the “Cell Structure” lesson, click Add Slide.
    • Create:
      • Slide 1 (Image): Upload a cell diagram with annotations.
      • Slide 2 (Quiz): Add a multiple-choice question: “What is the function of the nucleus?”
      • Slide 3 (Dialogue): Configure an AI-driven dialogue with the prompt: “Explain the role of mitochondria.”
    • Set slide transitions (e.g., fade) and save.
    • Expected Outcome: Slides are added and preview correctly in the lesson.

  5. Test Quiz and Dialogue:

    • Preview the quiz slide to ensure questions and answers display correctly.
    • Test the dialogue slide in the Home Interface to verify AI responses.
    • Expected Outcome: The quiz scores responses accurately, and the dialogue responds contextually.

  6. Export Course:

    • Select “Biology Basics” and click Export.
    • Download the course as a ZIP file.
    • Expected Outcome: The ZIP file contains all course content, including lessons and slides.

Best Practices

  • Organization: Use tags and class assignments to keep content organized.
  • Interactivity: Incorporate quizzes and dialogues to engage students.
  • Testing: Preview all content to ensure compatibility across devices.
  • Backups: Regularly export courses to prevent data loss.

🏫 5. Organizing Classes: Classes Management

The Classes Management page, accessible to Organization Admins and Teachers, allows you to create and manage classes, assign students, and link courses.

Key Features

  • Class Creation: Define classes with names, descriptions, and date ranges.
  • Student Assignment: Add or remove students in bulk.
  • Course Assignment: Link courses to classes for student access.
  • Class Details: View enrollment and activity status.

Steps to Use Classes Management

  1. Access Classes Management:

    • Navigate to the Classes Management page.
    • Expected Outcome: The class table loads, displaying existing classes.

  2. Create a Class:

    • Click Create Class and enter:
      • Name: “Grade 10 Science”
      • Description: “Science class for 10th-grade students”
      • Start Date: July 30, 2025
      • End Date: July 30, 2026
      • Status: Active
    • Click Create.
    • Expected Outcome: The class appears in the table with the specified details.

  3. Assign Students:

    • For “Grade 10 Science,” click Manage Students.
    • Search for “John Smith,” select, and click Add to Class.
    • Expected Outcome: John Smith is listed as an enrolled student.

  4. Assign Courses:

    • Click Manage Courses for “Grade 10 Science.”
    • Search for “Biology Basics,” select, and click Add to Class.
    • Expected Outcome: The course is linked to the class and accessible to students.

  5. View Class Details:

    • Click View Details for “Grade 10 Science.”
    • Verify enrollment (1 student) and assigned courses (1 course).
    • Expected Outcome: Details match the configured settings.

Best Practices

  • Clear Naming: Use descriptive class names (e.g., “Grade 10 Science”) for clarity.
  • Bulk Operations: Use bulk assignment for efficiency with large classes.
  • Status Monitoring: Regularly check class status and enrollment.

🛡️ 6. Managing Users and Organizations: Admin Panel

The Admin Panel, accessible to Super Admins and Organization Admins, provides tools to manage organizations, users, and roles.

Key Features

  • Organization Management: Create and configure organizations (Super Admins only).
  • User Management: Create, update, delete, and assign roles to users.
  • Role Management: Assign roles (Super Admin, Organization Admin, Teacher, Student, Restricted).
  • Filtering and Sorting: Search and organize users by name, email, role, or organization.

Steps to Use the Admin Panel

  1. Access Admin Panel:

    • Navigate to the Admin Panel from the main dashboard.
    • Expected Outcome: The panel loads with Organization and User Management sections.

  2. Create an Organization (Super Admin Only):

    • Click Create Organization.
    • Enter:
      • Name: “Test Academy”
      • Description: “A test organization for educational content.”
    • Click Create Organization.
    • Expected Outcome: The organization is created and listed.

  3. Create Users:

    • Expand the User Management section and click Create User.
    • Add a user:
      • First Name: “Jane”
      • Last Name: “Doe”
      • Email: “jane.doe@testacademy.com”
      • Password: “Test123456”
      • Organization: “Test Academy”
      • Role: “Teacher”
      • Language: “English”
    • Click Register.
    • Expected Outcome: The user is created, and a success notification appears.

  4. Update User Role:

    • Locate “Jane Doe” in the user table and click Edit.
    • Change Role to “Organization Admin.”
    • Click Update User.
    • Expected Outcome: Jane Doe’s role updates, and she gains Organization Admin privileges.

  5. Filter and Sort Users:

    • Use the search bar to find “Jane Doe.”
    • Filter by Organization: Test Academy and Role: Organization Admin.
    • Sort by Name (ascending).
    • Expected Outcome: Only Jane Doe appears, sorted correctly.

Best Practices

  • Role Assignment: Assign roles carefully to avoid granting excessive permissions.
  • User Management: Regularly review user lists and remove inactive accounts.
  • Notifications: Monitor toast notifications for success or error messages.

🎨 7. Personalizing the Platform: Customization

The Customization page, accessible to Super Admins and Organization Admins, allows you to tailor the app’s appearance and behavior for your organization.

Key Features

  • Color Customization: Set colors for navigation, footer, and icons.
  • Visibility Settings: Toggle UI elements like side navigation or footer.
  • Background Textures: Upload images for 3D environments.
  • Logo and Theme: Customize branding and UI themes.

Steps to Use Customization

  1. Access Customization:

    • Navigate to the Customization page.
    • Expected Outcome: The customization settings load.

  2. Update Appearance:

    • Set:
      • SideNav Color: Blue (#0000FF)
      • Show Side Navigation: Enabled
      • Logo Image: Upload test_logo.png
      • Show Top Left Logo: Enabled
      • Light Theme Primary Color: Green (HSL: 120, 100%, 50%)
    • Click Save.
    • Expected Outcome: The UI updates with the new colors and logo.

  3. Configure Extras:

    • Set Similarity Score: 0.8
    • Choose Organization Default Avatar: A specific 3D model.
    • Expected Outcome: FAQ responses use the 0.8 similarity score, and the avatar is set.

  4. Preview Changes:

    • Click View Beta Home to preview the customized interface.
    • Expected Outcome: The Home Interface reflects the new settings.

Best Practices

  • Branding: Use logos and colors that align with your organization’s identity.
  • Testing: Preview changes to ensure they display correctly across devices.
  • Consistency: Apply settings consistently to avoid user confusion.

✅ 8. End-to-End User Flow Example

To illustrate how all components work together, here’s an end-to-end flow for a Super Admin, Organization Admin, Teacher, and Student:

  1. Super Admin:

    • Creates an organization (“Test Academy”) in the Admin Panel.
    • Adds users: Organization Admin (“Org Admin”), Teacher (“Jane Doe”), and Student (“John Smith”).
    • Customizes the organization’s appearance (e.g., blue sidebar, logo) in the Customization page.

  2. Organization Admin:

    • Creates a class (“Grade 10 Science”) in the Classes Management page.
    • Assigns John Smith to the class.
    • Configures an AI flow in Flow Management to respond to “What is a cell?” with a predefined answer.

  3. Teacher:

    • Creates a course (“Biology Basics”) with a lesson (“Cell Structure”) in Content Management.
    • Adds slides (image, quiz, dialogue) to the lesson.
    • Assigns the course to “Grade 10 Science” via Classes Management.

  4. Student:

    • Logs in and navigates to the Home Interface.
    • Selects “Biology Basics” and interacts with the AI Teacher.
    • Uses chat and voice to ask questions, navigates slides, and completes a quiz.
    • Updates personal settings (e.g., nickname, theme) in the Settings page.

Expected Outcome: The platform supports seamless setup, content delivery, and interaction, with all components working together to provide a cohesive experience.

🛡️ 9. Best Practices for All Users

  • Navigation: Use the help link for detailed guidance.
  • Security: Keep passwords secure and update them regularly in the Settings page.
  • Content Quality: Preview courses, lessons, and flows to ensure accuracy and engagement.
  • Accessibility: Leverage voice controls, screen reader support, and high-contrast themes for inclusivity.
  • Backups: Export courses and user data regularly to prevent loss.
  • Collaboration: Coordinate between admins and teachers to align content and class assignments.

📊 10. Role-Based Access Summary

FeatureSuper AdminOrganization AdminTeacherStudent
Home InterfaceView, interactView, interactView, interactView, interact
Flow ManagementFull accessFull accessNoneNone
SettingsFull accessFull accessFull accessFull access
Content ManagementFull accessFull accessCreate, editView only
Classes ManagementFull accessFull accessManage assigned classesView enrolled classes
Admin PanelFull accessManage own orgNoneNone
CustomizationFull accessFull accessNoneNone

🌟 11. Getting Help

  • Documentation: Visit https://docs.teachingmachines.se/Guides/admin-panel for detailed guides.
  • Tooltips: Hover (desktop) or tap (mobile) on UI elements for contextual help.
  • Notifications: Monitor toast notifications for success or error messages.
  • Support: Contact your organization’s admin or Teaching Machines support for assistance.

This guide provides a comprehensive roadmap for using Teaching Machines, empowering users to set up, manage, and engage with educational content effectively. Start exploring the platform today and create a dynamic, AI-driven learning environment!

Getting StartedHome Interface