Allure Connect

SCORM API User Journey Index

This directory contains comprehensive user journey maps for all user types in the SCORM API application.

Overview

The SCORM API serves multiple user types, each with distinct goals and workflows. This documentation maps the exact paths, button presses, and interactions required for each user type to accomplish their tasks.

User Types

1. Public Visitors

File: public-visitor-journeys.md

Unauthenticated users browsing the service, learning about features, comparing pricing, and signing up.

Key Journeys:

  • First-time visitor exploring service
  • Developer researching API capabilities
  • Decision-maker comparing pricing
  • User signing up for trial
  • User completing onboarding

2. Customers/Tenants

File: customer-journeys.md

Authenticated users with tenant accounts, organized by usage type:

  • Unknown Users: New customers with no activity
  • SCORM API Users: Using SCORM package hosting
  • xAPI Users: Sending xAPI statements
  • SCORM Dispatch Users: Creating dispatch packages
  • Mixed Users: Using multiple features

Key Journeys:

  • New customer first login
  • SCORM API user uploading packages
  • SCORM API user launching sessions
  • xAPI user sending statements
  • Dispatch user creating dispatch packages
  • Managing API keys
  • Viewing reports
  • Configuring webhooks
  • Checking usage/quota
  • Managing billing

3. System Administrators

File: admin-journeys.md

Clerk-authenticated system administrators managing the entire platform.

Key Journeys:

  • Monitoring system health
  • Viewing SaaS metrics
  • Identifying at-risk tenants
  • Managing tenant API keys
  • Viewing all packages
  • Generating custom reports
  • Reviewing audit logs
  • Managing webhooks

4. Learners

File: learner-journeys.md

End users taking SCORM courses and tracking their learning progress.

Key Journeys:

  • Accessing learning dashboard
  • Launching SCORM sessions
  • Completing courses
  • Viewing progress

Navigation Structure

Public Navigation

  • Features → /features
  • Pricing → /pricing
  • Docs → /docs or /api/docs
  • Sign In → /sign-in
  • Get Started → /sign-up

Customer Navigation

  • Dashboard → /dashboard
  • My Learning → /learner/dashboard
  • Reports → /dashboard/reports
  • SCORM Dispatch → /dashboard/dispatch
  • API Keys → /dashboard/api-keys
  • Usage → /dashboard/usage
  • Webhooks → /dashboard/webhooks
  • Billing → /dashboard/billing

Admin Navigation

  • Admin Dashboard → /admin
  • Reports (All Tenants) → /admin/reports/learner-progress
  • Custom Reports → /admin/reports/custom
  • Packages (All Tenants) → /admin/packages
  • Webhooks (All Tenants) → /admin/webhooks
  • Tenants → /admin/tenants
  • API Keys (All Tenants) → /admin/api-keys
  • System → /admin/system
  • Audit Logs → /admin/audit-logs

Common Patterns

Conversion Funnel (Public → Customer)

  1. Landing page → Features/Pricing → Sign up → Onboarding → Dashboard
  2. Time: 5-15 minutes
  3. Key decision points: Feature evaluation, pricing comparison, plan selection

SCORM Workflow (Customer)

  1. Dashboard → Packages → Upload via API → Launch → View Reports
  2. Time: 10-15 minutes per package
  3. Key actions: API upload, session launch, progress tracking

Admin Monitoring (Admin)

  1. Admin Dashboard → System Health → SaaS Metrics → Tenant Activity
  2. Time: 5-10 minutes
  3. Key focus: System status, business metrics, tenant health

Learning Flow (Learner)

  1. Dashboard → Launch Session → Complete Content → View Progress
  2. Time: Varies by course
  3. Key focus: Content interaction, progress tracking, completion

Technical Context

  • Authentication: Clerk for web users, API keys for programmatic access
  • User Type Detection: Automatic based on usage patterns
  • Navigation: Dynamic based on user context (public/customer/admin)
  • Dashboard Widgets: User-type aware, showing relevant features
  • API-First: Many operations require API usage (package upload, xAPI statements)

Related Documentation