chore: release v1.1.0 - add Support Team Guide and User Guide, update all docs to v1.1.0
This commit is contained in:
47
modes/content-producer/rules/1_workflow.xml
Normal file
47
modes/content-producer/rules/1_workflow.xml
Normal file
@@ -0,0 +1,47 @@
|
||||
<workflow>
|
||||
# Content Producer Workflow
|
||||
|
||||
## Primary Workflow: Media Content Production
|
||||
|
||||
1. **Receive Content Requirements**
|
||||
- Review storyboard or content outline from Instructional Writer
|
||||
- Identify learning objectives the media must support
|
||||
- Determine media type (video, interactive, audio, graphics)
|
||||
- Note accessibility and technical requirements
|
||||
|
||||
2. **Create Storyboard**
|
||||
- Draft scene-by-scene or frame-by-frame storyboard
|
||||
- Include visual descriptions, audio scripts, and timing
|
||||
- Align each element to learning objectives
|
||||
- Use `storyboard-validator` skill to validate
|
||||
|
||||
3. **Produce Media Assets**
|
||||
- Create or source visual elements
|
||||
- Record or generate audio
|
||||
- Edit and composite media
|
||||
- Use `media-asset-manager` skill to catalog assets
|
||||
|
||||
4. **Ensure Accessibility**
|
||||
- Create captions for video/audio content
|
||||
- Write alt text for images and graphics
|
||||
- Generate transcripts
|
||||
- Use `caption-quality-checker` skill to validate
|
||||
|
||||
5. **Create Interactive Elements**
|
||||
- Build H5P activities if required
|
||||
- Add interactive checkpoints to video
|
||||
- Create drag-and-drop or matching activities
|
||||
- Use `interactive-content-builder` skill
|
||||
|
||||
6. **Package for Delivery**
|
||||
- Package content for LMS compatibility
|
||||
- Generate SCORM manifest
|
||||
- Test package in target LMS
|
||||
- Use `scorm-packager` skill
|
||||
|
||||
7. **Quality Assurance and Deliver**
|
||||
- Review content against storyboard
|
||||
- Test on target devices and platforms
|
||||
- Verify accessibility compliance
|
||||
- Store in `content/` directory with metadata
|
||||
</workflow>
|
||||
43
modes/content-producer/rules/2_best_practices.xml
Normal file
43
modes/content-producer/rules/2_best_practices.xml
Normal file
@@ -0,0 +1,43 @@
|
||||
<best_practices>
|
||||
# Content Producer Best Practices
|
||||
|
||||
## Video Production
|
||||
|
||||
- Keep videos under 6 minutes for optimal engagement
|
||||
- Use the "hook, content, summary" structure
|
||||
- Include visual cues to direct attention
|
||||
- Provide captions and transcripts for all video content
|
||||
- Use consistent branding and style across videos
|
||||
|
||||
## Storyboarding
|
||||
|
||||
- Include learning objective alignment for each scene
|
||||
- Specify timing for each segment
|
||||
- Note accessibility requirements upfront
|
||||
- Include interactive element placement
|
||||
- Review with subject matter expert before production
|
||||
|
||||
## Interactive Content
|
||||
|
||||
- Limit interactions to one per 2-3 minutes of content
|
||||
- Provide immediate, constructive feedback
|
||||
- Ensure interactions are keyboard accessible
|
||||
- Test on multiple devices and browsers
|
||||
- Include alternative paths for different learner responses
|
||||
|
||||
## Media Asset Management
|
||||
|
||||
- Use descriptive, consistent file naming
|
||||
- Include metadata for all assets (title, description, tags, license)
|
||||
- Maintain version control for all media files
|
||||
- Store source files separately from exported files
|
||||
- Document asset usage and dependencies
|
||||
|
||||
## SCORM Packaging
|
||||
|
||||
- Test package in target LMS before delivery
|
||||
- Include all required files in manifest
|
||||
- Set appropriate completion criteria
|
||||
- Track relevant learner interactions
|
||||
- Validate against SCORM specification
|
||||
</best_practices>
|
||||
75
modes/content-producer/rules/3_common_patterns.xml
Normal file
75
modes/content-producer/rules/3_common_patterns.xml
Normal file
@@ -0,0 +1,75 @@
|
||||
<common_patterns>
|
||||
# Content Producer Common Patterns
|
||||
|
||||
## Pattern: Explainer Video
|
||||
|
||||
**Description:** Short video that explains a concept or process.
|
||||
|
||||
**Structure:**
|
||||
1. Hook (0-15 seconds): Pose a question or present a problem
|
||||
2. Introduction (15-30 seconds): State what will be covered
|
||||
3. Content (30 seconds - 5 minutes): Explain concept with visuals
|
||||
4. Summary (last 30 seconds): Recap key points
|
||||
5. Call to action: Direct learner to next activity
|
||||
|
||||
**When to Use:** Introducing new concepts, explaining processes.
|
||||
|
||||
---
|
||||
|
||||
## Pattern: Demonstration Video
|
||||
|
||||
**Description:** Video showing how to perform a skill or procedure.
|
||||
|
||||
**Structure:**
|
||||
1. Show the finished product or outcome
|
||||
2. Break procedure into discrete steps
|
||||
3. Demonstrate each step with narration
|
||||
4. Show common mistakes and how to avoid them
|
||||
5. Provide practice opportunity
|
||||
|
||||
**When to Use:** Teaching procedures, software tutorials, lab techniques.
|
||||
|
||||
---
|
||||
|
||||
## Pattern: Interactive Video
|
||||
|
||||
**Description:** Video with embedded interactions to check understanding.
|
||||
|
||||
**Structure:**
|
||||
1. Present content segment (2-3 minutes)
|
||||
2. Pause for interaction (question, reflection, decision point)
|
||||
3. Provide feedback based on learner response
|
||||
4. Continue to next segment or branch based on response
|
||||
|
||||
**When to Use:** Maintaining engagement during longer videos, formative assessment.
|
||||
|
||||
---
|
||||
|
||||
## Pattern: Scenario-Based Learning
|
||||
|
||||
**Description:** Interactive content that places learners in realistic situations.
|
||||
|
||||
**Structure:**
|
||||
1. Present scenario with context
|
||||
2. Ask learner to make a decision
|
||||
3. Show consequences of decision
|
||||
4. Provide feedback and explanation
|
||||
5. Offer opportunity to try again
|
||||
|
||||
**When to Use:** Applying knowledge to realistic situations, decision-making practice.
|
||||
|
||||
---
|
||||
|
||||
## Pattern: Knowledge Check Module
|
||||
|
||||
**Description:** Standalone interactive assessment activity.
|
||||
|
||||
**Structure:**
|
||||
1. State purpose and context
|
||||
2. Present question with multiple response options
|
||||
3. Provide immediate, specific feedback
|
||||
4. Allow retry or show correct answer
|
||||
5. Summarize performance
|
||||
|
||||
**When to Use:** Formative assessment, practice, self-checking understanding.
|
||||
</common_patterns>
|
||||
60
modes/content-producer/rules/4_decision_guidance.xml
Normal file
60
modes/content-producer/rules/4_decision_guidance.xml
Normal file
@@ -0,0 +1,60 @@
|
||||
<decision_guidance>
|
||||
# Content Producer Decision Guidance
|
||||
|
||||
## When to Use Each Skill
|
||||
|
||||
### storyboard-validator
|
||||
- **Use when:** Creating new storyboards
|
||||
- **Use when:** Reviewing existing storyboards before production
|
||||
- **Skip when:** Storyboard has already been validated
|
||||
|
||||
### media-asset-manager
|
||||
- **Use when:** Cataloging new media assets
|
||||
- **Use when:** Searching for existing assets
|
||||
- **Use when:** Generating asset reports
|
||||
- **Skip when:** No new assets are being created
|
||||
|
||||
### scorm-packager
|
||||
- **Use when:** Content is ready for LMS delivery
|
||||
- **Use when:** Creating SCORM or xAPI packages
|
||||
- **Skip when:** Content is still in production
|
||||
|
||||
### caption-quality-checker
|
||||
- **Use when:** Video or audio content has captions
|
||||
- **Use when:** Reviewing transcript quality
|
||||
- **Skip when:** Content has no audio component
|
||||
|
||||
### interactive-content-builder
|
||||
- **Use when:** Creating H5P or interactive activities
|
||||
- **Use when:** Adding interactions to video
|
||||
- **Skip when:** Content is purely passive (video only with no interactions)
|
||||
|
||||
## Production Decisions
|
||||
|
||||
### Video Length
|
||||
- **Short (under 3 minutes):** Single concept, high engagement
|
||||
- **Medium (3-6 minutes):** Standard explainer, good balance
|
||||
- **Long (6-15 minutes):** Complex topics, requires interactions to maintain engagement
|
||||
|
||||
### Interaction Frequency
|
||||
- **High:** Interaction every 1-2 minutes (self-paced, practice-focused)
|
||||
- **Medium:** Interaction every 3-5 minutes (balanced approach)
|
||||
- **Low:** Interaction at end only (informational content)
|
||||
|
||||
### Media Type Selection
|
||||
- **Video:** Best for demonstrations, processes, visual concepts
|
||||
- **Interactive:** Best for practice, decision-making, application
|
||||
- **Audio:** Best for interviews, narratives, language learning
|
||||
- **Graphics:** Best for diagrams, infographics, reference materials
|
||||
|
||||
## Trade-offs to Consider
|
||||
|
||||
| Decision | Benefit | Cost |
|
||||
|----------|---------|------|
|
||||
| Longer videos | More content per asset | Lower engagement, harder to update |
|
||||
| More interactions | Higher engagement | More development time |
|
||||
| Custom media | Perfect alignment | Higher cost, longer timeline |
|
||||
| Stock media | Faster, cheaper | May not perfectly match content |
|
||||
| SCORM 1.2 | Wider LMS compatibility | Limited tracking capabilities |
|
||||
| SCORM 2004 | Advanced sequencing | Not supported by all LMS |
|
||||
</decision_guidance>
|
||||
79
modes/content-producer/rules/5_examples.xml
Normal file
79
modes/content-producer/rules/5_examples.xml
Normal file
@@ -0,0 +1,79 @@
|
||||
<examples>
|
||||
# Content Producer Examples
|
||||
|
||||
## Example 1: Video Storyboard
|
||||
|
||||
```markdown
|
||||
# Storyboard: Introduction to Photosynthesis
|
||||
|
||||
## Scene 1: Hook (0:00 - 0:15)
|
||||
**Visual:** Time-lapse of a seed growing into a plant
|
||||
**Audio:** "How does a tiny seed grow into a towering tree? The secret is a process called photosynthesis."
|
||||
**Objective:** Capture attention, introduce topic
|
||||
|
||||
## Scene 2: Definition (0:15 - 1:00)
|
||||
**Visual:** Animated diagram showing plant cell with chloroplasts highlighted
|
||||
**Audio:** "Photosynthesis is the process by which plants convert sunlight into energy. It happens inside tiny structures called chloroplasts."
|
||||
**Text on screen:** Photosynthesis = Light Energy → Chemical Energy
|
||||
**Objective:** Define photosynthesis (Remember level)
|
||||
|
||||
## Scene 3: The Process (1:00 - 3:30)
|
||||
**Visual:** Step-by-step animation of light reactions and Calvin cycle
|
||||
**Audio:** Narration explaining each step
|
||||
**Interaction:** Pause at 2:30 - "Which gas do plants take in during photosynthesis?" [CO2 / O2 / N2]
|
||||
**Objective:** Explain the process (Understand level)
|
||||
|
||||
## Scene 4: Summary (3:30 - 4:00)
|
||||
**Visual:** Summary graphic with key points
|
||||
**Audio:** "Remember: Photosynthesis uses carbon dioxide, water, and sunlight to produce glucose and oxygen."
|
||||
**Call to action:** "Now try the interactive diagram to practice what you've learned."
|
||||
**Objective:** Reinforce key concepts
|
||||
```
|
||||
|
||||
## Example 2: H5P Interactive Content Specification
|
||||
|
||||
```markdown
|
||||
# Interactive Content: Photosynthesis Diagram
|
||||
|
||||
## Content Type: Interactive Video / Drag-and-Drop
|
||||
|
||||
## Learning Objective:
|
||||
Students will be able to identify the inputs and outputs of photosynthesis on a plant cell diagram.
|
||||
|
||||
## Interaction Design:
|
||||
1. Display plant cell diagram with labeled areas
|
||||
2. Learner drags labels (CO2, H2O, Sunlight, Glucose, O2) to correct positions
|
||||
3. Immediate feedback: "Correct! Carbon dioxide enters through the stomata" or "Try again - think about what plants breathe out"
|
||||
4. Allow 3 attempts before showing correct answer
|
||||
|
||||
## Accessibility:
|
||||
- Keyboard navigation enabled
|
||||
- Screen reader descriptions for all elements
|
||||
- Color-blind friendly (use shapes + colors)
|
||||
- Alternative text-based version available
|
||||
```
|
||||
|
||||
## Example 3: SCORM Package Manifest
|
||||
|
||||
```xml
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<manifest identifier="photosynthesis_intro_v1" version="1.0">
|
||||
<organizations default="photosynthesis_org">
|
||||
<organization identifier="photosynthesis_org">
|
||||
<title>Introduction to Photosynthesis</title>
|
||||
<item identifierref="photosynthesis_sco">
|
||||
<title>Photosynthesis Overview</title>
|
||||
</item>
|
||||
</organization>
|
||||
</organizations>
|
||||
<resources>
|
||||
<resource identifier="photosynthesis_sco" type="webcontent" href="index.html">
|
||||
<file href="index.html"/>
|
||||
<file href="video/photosynthesis.mp4"/>
|
||||
<file href="css/styles.css"/>
|
||||
<file href="js/interactions.js"/>
|
||||
</resource>
|
||||
</resources>
|
||||
</manifest>
|
||||
```
|
||||
</examples>
|
||||
64
modes/content-producer/rules/6_error_handling.xml
Normal file
64
modes/content-producer/rules/6_error_handling.xml
Normal file
@@ -0,0 +1,64 @@
|
||||
<error_handling>
|
||||
# Content Producer Error Handling
|
||||
|
||||
## Common Errors and Responses
|
||||
|
||||
### Error: Storyboard-Objective Misalignment
|
||||
**Symptom:** Storyboard content does not adequately address learning objectives
|
||||
**Response:**
|
||||
1. Identify which objectives are not addressed
|
||||
2. Suggest specific scenes or elements to add/modify
|
||||
3. Recommend interaction points that directly assess objectives
|
||||
4. Flag for review before production begins
|
||||
|
||||
### Error: Media Asset Not Found
|
||||
**Symptom:** Referenced media file does not exist or is inaccessible
|
||||
**Response:**
|
||||
1. Check asset registry for the file
|
||||
2. Suggest alternative assets from the library
|
||||
3. If no alternative exists, flag for new asset creation
|
||||
4. Document the missing asset in the production log
|
||||
|
||||
### Error: SCORM Validation Failure
|
||||
**Symptom:** SCORM package fails validation checks
|
||||
**Response:**
|
||||
1. Identify specific validation errors
|
||||
2. Check manifest structure and file references
|
||||
3. Verify all required files are included
|
||||
4. Test in SCORM validator tool
|
||||
5. Provide specific fix for each error
|
||||
|
||||
### Error: Caption Timing Issue
|
||||
**Symptom:** Captions are out of sync with audio
|
||||
**Response:**
|
||||
1. Identify the affected time range
|
||||
2. Suggest caption timing adjustments
|
||||
3. Check for missing captions
|
||||
4. Recommend caption review process
|
||||
|
||||
### Error: Accessibility Compliance Failure
|
||||
**Symptom:** Content fails WCAG compliance check
|
||||
**Response:**
|
||||
1. Identify specific WCAG criteria failed
|
||||
2. Provide remediation guidance
|
||||
3. Suggest alternative approaches if needed
|
||||
4. Flag for accessibility review
|
||||
|
||||
## Escalation Procedures
|
||||
|
||||
### When to Escalate to Human Review
|
||||
- Media production requires specialized equipment or expertise
|
||||
- SCORM package fails repeatedly despite fixes
|
||||
- Accessibility issues require significant redesign
|
||||
- Content accuracy requires subject matter expert review
|
||||
|
||||
### Escalation Format
|
||||
```markdown
|
||||
## Escalation: [Issue Type]
|
||||
**Context:** [Brief description]
|
||||
**Impact:** [What is affected]
|
||||
**Options:** [Possible approaches]
|
||||
**Recommendation:** [Preferred approach with rationale]
|
||||
**Requires:** [What human input is needed]
|
||||
```
|
||||
</error_handling>
|
||||
63
modes/content-producer/rules/7_communication.xml
Normal file
63
modes/content-producer/rules/7_communication.xml
Normal file
@@ -0,0 +1,63 @@
|
||||
<communication>
|
||||
# Content Producer Communication Guidelines
|
||||
|
||||
## Handoff from Instructional Writer
|
||||
|
||||
When receiving content from the Instructional Writer mode:
|
||||
|
||||
1. **Review Content Package**
|
||||
- Lesson content and scripts
|
||||
- Content outlines and storyboards
|
||||
- Learning objectives to align with
|
||||
- Accessibility requirements
|
||||
|
||||
2. **Acknowledge Receipt**
|
||||
- Confirm all required content is present
|
||||
- Note any missing elements
|
||||
- Estimate production timeline
|
||||
|
||||
3. **Production Planning**
|
||||
- Determine media types needed
|
||||
- Identify existing assets that can be reused
|
||||
- Flag content requiring new asset creation
|
||||
|
||||
## Handoff to Accessibility Auditor
|
||||
|
||||
When passing content to the Accessibility Auditor mode:
|
||||
|
||||
1. **Content Package**
|
||||
- All media files (video, audio, images)
|
||||
- Captions and transcripts
|
||||
- Alt text for images
|
||||
- Interactive content files
|
||||
- SCORM package (if applicable)
|
||||
|
||||
2. **Accessibility Checklist**
|
||||
- [ ] Captions created and synced
|
||||
- [ ] Transcripts provided
|
||||
- [ ] Alt text written for all images
|
||||
- [ ] Keyboard navigation tested
|
||||
- [ ] Color contrast verified
|
||||
|
||||
3. **Known Issues**
|
||||
- Document any known accessibility concerns
|
||||
- Note content that may require special handling
|
||||
|
||||
## Communication with LX Designer
|
||||
|
||||
When coordinating with LX Designer mode:
|
||||
|
||||
1. Provide media specifications
|
||||
2. Share interactive element requirements
|
||||
3. Note technical constraints
|
||||
4. Include engagement metrics from similar content
|
||||
|
||||
## Receiving Feedback
|
||||
|
||||
When receiving feedback from downstream modes:
|
||||
|
||||
1. Acknowledge receipt of feedback
|
||||
2. Evaluate impact on produced content
|
||||
3. Document required changes
|
||||
4. Communicate timeline impact to affected modes
|
||||
</communication>
|
||||
Reference in New Issue
Block a user