Allure Connect

SCORM API Documentation

Long-form guides, references, and examples for integrating with Connect’s SCORM runtime and HTTP APIs. Browse by path from the main Documentation hub or jump in below.

Quick links

Site structure analysis (reference)

The following sections document a structure and navigation analysis for the SCORM API content set. They were conducted to:

  1. Map user journeys for all user types
  2. Analyze current website structure and navigation
  3. Identify issues with discoverability and organization
  4. Propose actionable improvements

Directory Structure

docs/scorm-api/
├── README.md (this file)
├── user-journeys/
│   ├── index.md                    # Master index for user journeys
│   ├── public-visitor-journeys.md   # Public visitor journey maps
│   ├── customer-journeys.md         # Customer/tenant journey maps
│   ├── admin-journeys.md           # Admin journey maps
│   └── learner-journeys.md          # Learner journey maps
└── structure-analysis/
    ├── navigation-analysis.md              # Current navigation analysis
    ├── page-organization-analysis.md       # Current page structure analysis
    ├── information-architecture-analysis.md # IA analysis
    ├── proposed-navigation-structure.md    # Proposed navigation improvements
    ├── proposed-page-organization.md      # Proposed page organization
    └── implementation-recommendations.md  # Actionable implementation plan

Key Findings

Critical Issues Identified

  1. Overwhelming Navigation: 8+ items in dropdowns with no grouping
  2. Hidden Features: Credentials and xAPI pages not in navigation
  3. Unclear Categorization: Features not grouped logically
  4. Missing Breadcrumbs: Can't see navigation path on detail pages
  5. Inconsistent Patterns: Mixed route structures and naming

Proposed Solutions

  1. Mega Menu Navigation: Group features by category (Content, Analytics, Integrations, Account)
  2. Page Consolidation: Unify Reports and Integrations with tabs
  3. Breadcrumbs: Add to all detail pages
  4. Context Indicators: Show user type and context
  5. Improved Mobile: Collapsible sections and search

User Journey Maps

Public Visitors

  • First-time visitor exploration
  • Developer API research
  • Pricing comparison
  • Sign-up and onboarding flows

Customers/Tenants

  • New customer first login
  • SCORM package management
  • xAPI statement tracking
  • Dispatch package creation
  • API key and webhook configuration
  • Reports and analytics
  • Billing management

System Administrators

  • System health monitoring
  • SaaS metrics review
  • Tenant management
  • Package oversight
  • Custom report generation
  • Audit log review

Learners

  • Learning dashboard access
  • SCORM session launching
  • Course completion
  • Progress tracking

Structure Analysis

Navigation Analysis

  • Identified 10+ navigation issues
  • Found confusion points
  • Discovered missing elements
  • Recommended mega menu structure

Page Organization Analysis

  • Identified route inconsistencies
  • Found redundancy issues
  • Discovered missing pages
  • Recommended consolidation strategies

Information Architecture Analysis

  • Identified categorization issues
  • Found mental model mismatches
  • Discovered discoverability gaps
  • Recommended feature grouping

Implementation Plan

Phase 1: Quick Wins (Week 1)

  • Add missing navigation links
  • Add breadcrumbs
  • Remove redundant labels
  • Add context indicators

Phase 2: Reorganization (Week 2-3)

  • Implement mega menu navigation
  • Consolidate Reports pages
  • Consolidate Integrations pages
  • Improve mobile navigation

Phase 3: Enhancements (Week 4+)

  • Add Settings page
  • Add Help Center
  • Implement command palette
  • Add package upload UI

Success Metrics

  • Navigation efficiency: <10 seconds to find feature
  • Feature discovery: >80% found without help
  • Cognitive load: 30% reduction
  • User satisfaction: >4/5 rating

Next Steps

  1. Review all analysis documents
  2. Prioritize recommendations
  3. Begin Phase 1 implementation
  4. Gather user feedback
  5. Iterate based on results

Related Documentation