Modules
Comprehensive guide to the ikigize modules system with block-based outlines, sequential learning, and flexible content organization.
Overview
Modules are the fundamental building blocks of learning content in the ikigize platform. They represent discrete, self-contained learning units that can be created, shared, and combined to form comprehensive learning experiences. Each module focuses on a specific topic or skill area and contains structured content designed to help learners achieve defined objectives.
Core Characteristics
Structure & Content
- Title & Objective: Clear title and learning objective defining learner accomplishments
- Block-Based Outline: Structured outline system with sequential content blocks (planned feature)
- Difficulty Levels: 1-5 scale rating (Beginner to Expert) for learner guidance
- Status Management: Draft or published states
- Content Types: Support for various block types including chapters, tasks, sessions, assessments
- Sequential Learning: Logical progression with dependencies and unlock conditions (planned)
- Embedding Support: Vector embeddings for intelligent search and similarity matching
Module Types
The platform supports multiple approaches to module creation, from manual authoring to AI-assisted generation. Each approach serves different needs and workflows, allowing creators to choose the method that best fits their content development process.
Manual Modules
Created from scratch by users with full control over content and structure. Most flexible for custom learning experiences and specialized topics.
Template Modules
Pre-built modules that can be copied and adapted for different contexts. Ideal starting points for common learning topics and standardized content.
Generated Modules
AI-created modules using the platform's AI Dean assistant. Leverage artificial intelligence to quickly develop comprehensive content structures.
Course Modules
Modules specifically designed as part of larger course structures. Optimized to work within complete learning program contexts.
Standalone Modules
Independent learning units not tied to specific courses. Perfect for self-directed learning, microlearning, or as reusable building blocks.
Module Structure
Block System Development
The block-based module outline system is currently in development. When available, modules will support the same flexible block structure as courses, enabling sequential learning experiences with various content types and unlock conditions.
Planned Block Types
Once the block system is implemented, modules will support a variety of content blocks to create rich learning experiences:
Block Unlock Conditions (Planned)
The upcoming block system will support sophisticated unlock conditions to pace learning:
⏰ Time-Based Unlocking
- Scheduled Release: Blocks unlock at specific dates and times
- Duration Delays: Blocks unlock after a set period from module start
- Learning Pace: Blocks unlock based on recommended learning schedules
✅ Completion-Based Unlocking
- Sequential Completion: Block unlocks when previous block is completed
- Multiple Prerequisites: Block unlocks when all specified prerequisite blocks are completed
- Milestone Requirements: Block unlocks when specific learning milestones are achieved
- Assessment Thresholds: Block unlocks when assessment scores meet minimum requirements
🔄 Flexible Requirements
- Required vs Optional: Blocks can be marked as required or optional for module completion
- Alternative Paths: Learners can choose between different block sequences
- Conditional Logic: Blocks unlock based on learner preferences, performance, or choices
Ownership & Visibility
Module ownership and visibility settings determine who controls the module and how it can be accessed for copying and reuse. Unlike courses, modules operate in a single-context system focused exclusively on template usage and replication.
Single-Context Access: No Direct Join
Modules do NOT have "join" functionality like courses. Users cannot join modules directly as students. Instead:
Module Access for Students → Only through parent courses or direct role assignment
Module Access for Copying → Controlled by visibility and usage conditions
This means visibility and usage conditions control only who can copy the module to add it to their own catalogues or courses, NOT who can join it as a learner.
How Module Access Works
Student Access (Learning)
- Students access modules ONLY through courses that include them
- Course admins manually assign module roles (Author, Instructor, Admin, etc.)
- No public or direct "join" functionality for modules
Template Access (Copying)
- Visibility determines where the module appears in catalogues
- Usage conditions control who can copy it
- When copied, creates a linked copy tied to the original template
- All copies maintain connection for tracking, analytics, updates, and licensing
Template Linking Benefits
Every module copy is linked to the original template module, enabling:
- Activity Matching → Track related learning across all instances
- Update Sharing → Propagate improvements to derivatives
- Usage Analytics → Monitor adoption and effectiveness
- Licensing Compliance → Track and enforce usage terms
- User Matching → Connect learners across similar content
Ownership Types
Every module has an owner who controls its configuration, content, access settings, and usage conditions:
User Ownership
- Individual creator maintains full control
- Can transfer ownership to organizations
- Ideal for personal modules and independent creators
Organization Ownership
- Organization controls the module
- Multiple admins can manage
- Suitable for corporate training and institutional modules
Public Ownership
- Module is managed by the platform or broader community
- Oversight by appointed platform administrators or moderators
- Ideal for open educational resources or shared community initiatives
Understanding Module Visibility
Module visibility determines where your module can be discovered by users who want to copy it into their own catalogues or add it to their courses. It does NOT control who can join as a student (that's handled by parent courses).
Real-World Example: A university creates an excellent "Research Methods" module. They want:
- Campus instructors to add it to their courses (Visibility: Campus catalogue)
- Other universities to copy and adapt it (Visibility: Public catalogue)
- Internal use with tracking and analytics (Usage Conditions: Free to Use with attribution)
This visibility system makes it possible. Instructors discover and add the module to courses, while educators worldwide can find and adapt the module structure.
Visibility for Copying, Not Joining
Think of module visibility as determining where the module appears in template catalogues, NOT where students can join. Students access modules through courses, not through direct discovery.
Visibility Settings
Visibility controls discoverability - where users can find your module to copy it into catalogues or courses.
Maximum exposure across the platform
Best for: Open educational resources, community learning content
Visible to specific organization(s) members
Best for: Corporate training modules, internal learning content
Visible to specific campus(es) community
Best for: Department modules, campus learning resources
Visible only within specific courses
Best for: Custom course modules, specialized learning sequences
Hidden from all catalogues
Best for: Work-in-progress modules, exclusive content, testing
Multiple Catalogue Visibility
Modules can be visible in multiple catalogues simultaneously. For example, a module can be:
- Public + Multiple Organizations: Wide reach while maintaining organizational tracking
- Multiple Campuses: Enable inter-campus collaboration and shared module libraries
- Organizations + Campuses: Target specific institutional audiences across boundaries
Strategic Visibility
Use multiple catalogue visibility to maximize appropriate exposure. A professional skills module can be public for general discovery while also appearing in specific organization catalogues for branded employee access.
Usage Conditions
Usage conditions define the access requirements and process for users to copy and use your module in their catalogues or courses. When a module is copied, it creates a linked copy that maintains connection to the original template.
User Experience
Click "Add Module" → Module copied and linked → Customize and use in your context
Module Owner Experience
Module is copied and linked freely. Track usage metrics, activity, and derivatives. No approval needed.
Configuration Options
Ideal For
Not Ideal For
Template Linkage System
All module copies are automatically linked to the original template module. This enables:
- Centralized tracking of all instances and usage
- Update propagation from template to derivatives
- Aggregated analytics across all copies
- Licensing compliance monitoring
- User and activity matching for collaborative learning insights
Advanced Usage Conditions
Beyond the three basic usage types, module owners can configure additional conditions to control usage, monetization, tracking, and distribution:
Module Payment Options
License Types
Attribution Requirements
Usage Rights
Allowed Modifications
Derivative Controls
Linkage System
Usage Analytics
Version Management
Update Propagation
Compliance Monitoring
Support Tiers
Visibility + Usage Matrix
Understanding how visibility settings and usage conditions work together to control module access:
| Visibility | Add to Course | Copy to Catalogue |
|---|---|---|
Public | Any course creator Any course creator can add a linked copy of this module to their course | Any user can copy Any user can create a linked copy to add to their personal or organizational catalogue |
Organizations | Org course creators Organization members can add a linked copy to courses within the organization | Org members copy Organization members can create linked copies for their catalogues |
Campuses | Campus course creators Campus members can add a linked copy to courses within the campus | Campus members copy Campus members can create linked copies for their catalogues |
Private | Manual assignment only Users with direct access can manually add to their courses | No copying allowed Module cannot be copied; accessible only through direct role assignment |
No Direct Student Access
Unlike courses, modules cannot be "joined" directly by students. Students access modules only through parent courses or by being manually assigned roles. Visibility controls where modules appear for copying and course integration, not for direct student enrollment.
Template Linking System
All module copies are automatically linked to the original template. This enables tracking, analytics, updates, licensing compliance, and user/activity matching across all instances—regardless of visibility settings.
Visibility + Usage Conditions + Roles
This matrix shows visibility-based discoverability. What users can actually do depends on: (1) Usage Conditions (Free to Use, Ask to Use, Private), (2) Assigned Roles (Superadmin, Admin, Author, Instructor, Student). See the Usage Conditions and Roles & Permissions sections for complete details.
Roles & Permissions
Module roles define what specific users can do within a module. While ownership determines control, visibility determines discoverability for copying, and usage conditions determine who can create copies—roles grant the actual permissions to view, edit, manage, teach, and interact with module content.
How Roles Are Assigned
Module owners (or users with Superadmin/Admin roles) can assign roles to other users. Roles are assigned in two primary ways:
- Direct Assignment: Manually assigning roles to users for the original module
- Course Inheritance: When a module is added to a course, course admins can assign module-specific roles within that context
Once assigned, roles determine exact capabilities. Users can hold multiple roles simultaneously, and permissions from all roles are combined additively.
Understanding Module Roles
Module roles operate independently from visibility and usage conditions. Remember:
- Visibility → Where the module can be discovered in catalogues
- Usage Conditions → Who can copy the module to their catalogues or courses
- Roles → What specific users can do within the module (original or copy)
A user might discover a module through a public catalogue, copy it via "Free to Use" conditions, but still need specific roles (like Author or Instructor) to edit content or manage the module instance.
Key Points:
- Owner = Automatic Superadmin: Module owners automatically have all Superadmin permissions
- Multiple Roles Allowed: Users can have several roles (e.g., Author + Instructor)
- Additive Permissions: More roles means more capabilities, never fewer
- Explicit Assignment: Roles must be explicitly assigned; they don't inherit from other contexts
- Context-Specific: Module roles apply within the module context, whether original or copy
Available Module Roles
Each role grants a specific set of permissions for working with module content, structure, and management:
Complete control over the module
Key Capabilities:
Typical Users: Module owner, organization superadmins
Manage module content and users
Key Capabilities:
Typical Users: Module administrators, content managers
Create and edit module content
Key Capabilities:
Typical Users: Content creators, subject matter experts
Deliver and manage module learning
Key Capabilities:
Typical Users: Teachers, trainers, facilitators
Learn and participate in the module
Key Capabilities:
Typical Users: Learners, participants, course members
Common Role Combinations
Users often benefit from multiple roles to fulfill complex responsibilities:
Author + Instructor
- Create content AND deliver learning experiences
- Ideal for: Subject matter experts who both develop and teach
Admin + Author
- Manage users AND create content
- Ideal for: Module managers who also create materials
Instructor + Student
- Teach AND learn simultaneously
- Ideal for: Teaching assistants who are also learners
Complete Permissions Matrix
The following matrix shows exactly what each role can do at the module level:
| Permission | Superadmin | Admin | Instructor | Author | Student |
|---|---|---|---|---|---|
| Core Access | |||||
| View Module | |||||
| Use Module | |||||
| Content Management | |||||
| Edit Module Content | |||||
| Create Task | |||||
| Create Session | |||||
| Archive Module Content | |||||
| Templates & Licensing | |||||
| Template Creation | |||||
| License Module | |||||
| Management | |||||
| Manage Module Users | |||||
| View Module Analytics | |||||
Permission Scenarios
Scenario 1: Content Creator + Instructor
- Roles: Author + Instructor
- Can: Edit content, create tasks AND sessions, create templates, view analytics
- Use Case: Subject matter expert who creates and delivers content
Scenario 2: Module Administrator
- Roles: Admin (single role)
- Can: Manage all content, users, and settings (except licensing)
- Use Case: Module manager handling day-to-day operations
Scenario 3: Learning Designer
- Roles: Author (single role)
- Can: Focus purely on content creation without user management
- Use Case: Instructional designer creating learning materials
Role Assignment Strategy
For detailed guidance on role assignment best practices, multiple role strategies, and implementation patterns, see the Roles & Permissions System documentation.
Module Lifecycle
Every module on ikigize follows a natural progression from initial planning to ongoing refinement. This lifecycle ensures that modules are well-designed, thoroughly tested, and continuously improved based on learner feedback and evolving educational needs.
Planning & Design
Define the module vision, learning objectives, and structural foundation:
- •Define specific learning objectives and measurable outcomes for the module
- •Plan block structure and organize content types (chapters, tasks, assessments, sessions)
- •Set difficulty level (1-5 scale) to guide learner expectations
- •Design unlock conditions and prerequisites for sequential learning
- •Determine ownership and visibility settings for target audience
Content Creation
Develop comprehensive learning materials and organize blocks:
- •Create learning content blocks with clear objectives and rich multimedia
- •Develop tasks and assessments that reinforce learning and measure outcomes
- •Prepare supporting resources and integrate relevant materials
- •Configure block sequences with logical progression and dependencies
- •Set up time-based or completion-based unlock conditions for pacing
Review & Testing
Validate content quality, block sequencing, and learning progression:
- •Validate individual block content for quality, accuracy, and clarity
- •Test block sequence flow to ensure smooth learning progression
- •Verify unlock conditions work as intended and create optimal pacing
- •Review assessment effectiveness and alignment with learning objectives
- •Conduct pilot testing with sample learners to validate the learning experience
Publication & Distribution
Release the module and integrate into courses or share independently:
- •Set final visibility settings and access control configuration
- •Integrate into courses or make available as standalone module
- •Share across campuses, organizations, or publish publicly as needed
- •Mark as template if designed for reuse and adaptation
- •Monitor initial usage and gather learner feedback
Iteration & Improvement
Continuously improve module effectiveness based on analytics and feedback:
- •Update individual blocks based on learner performance and feedback
- •Optimize block sequences and dependencies based on completion patterns
- •Refine unlock conditions to improve learning pacing and outcomes
- •Add or remove blocks to enhance learning effectiveness
- •Analyze block-level analytics to identify improvement opportunities
Related Documentation
- Courses System - How modules integrate into larger learning programs
- Sessions System - Interactive learning activities within modules
- Tasks System - Assignments and exercises as module blocks
- Resources System - Learning materials and references
- Roles & Permissions System - Complete guide to role-based access control
- Ownership System - Understanding entity ownership and control
- System Overview - Understanding the broader platform architecture