Files

15 KiB

Software Requirements Specification (SRS)

Innovation Content: Educational Content Development Modes & Skills

Version: 1.1.1 Date: 2026-04-24 Status: Final


1. Introduction

1.1 Purpose

This document specifies the software requirements for the Innovation Content project—a suite of specialized modes and skills for Roo Code that enable educational content developers and producers to create high-quality, accessible educational materials.

1.2 Scope

The project provides:

  • 6 specialized modes for different educational content roles
  • 30 skills supporting those modes (5 per mode)
  • 42 XML instruction files defining behavior patterns (7 per mode)
  • Configuration files for mode registration
  • Comprehensive documentation

1.3 Definitions and Acronyms

Term Definition
Mode A specialized configuration of Roo Code for a specific role
Skill A reusable capability that can be invoked by modes
LMS Learning Management System
SCORM Sharable Content Object Reference Model
xAPI Experience API (Tin Can API)
WCAG Web Content Accessibility Guidelines
Bloom's Taxonomy Classification of learning objectives by cognitive level

1.4 References

  • Roo Code Mode Writer documentation
  • WCAG 2.1/2.2 Guidelines
  • SCORM 2004 Specification
  • Bloom's Taxonomy Framework

2. Overall Description

2.1 Product Perspective

The Innovation Content project extends Roo Code's capabilities by providing domain-specific modes and skills tailored to educational content development. Each mode operates as a specialized agent with defined permissions, behaviors, and workflows.

2.2 Product Functions

  1. Curriculum Design: Create and validate educational curricula
  2. Instructional Writing: Produce engaging lesson content
  3. Assessment Development: Design valid and reliable assessments
  4. Content Production: Create multimedia educational materials
  5. Learning Experience Design: Design engaging learner journeys
  6. Accessibility Auditing: Ensure content meets accessibility standards

2.3 User Characteristics

User Role Expertise Primary Modes
Curriculum Designer Educational design, standards alignment curriculum-designer
Instructional Writer Writing, pedagogy instructional-writer
Assessment Developer Psychometrics, measurement assessment-dev
Content Producer Multimedia production content-producer
LX Designer UX design, engagement lx-designer
Accessibility Specialist WCAG, assistive technology accessibility-auditor

2.4 Constraints

  • Modes must operate within defined file permissions
  • Skills must be self-contained and documented
  • All content must comply with educational standards
  • Accessibility is mandatory, not optional

2.5 Assumptions

  • Users have basic familiarity with Roo Code
  • Educational content follows organizational standards
  • Target platforms support SCORM/xAPI content
  • Accessibility requirements are known and documented

3. Specific Requirements

3.1 Mode Requirements

3.1.1 Curriculum Designer Mode

ID: MODE-001
Priority: Critical

Functional Requirements:

  • FR-001: Must validate learning objectives against Bloom's Taxonomy
  • FR-002: Must map objectives to competency frameworks
  • FR-003: Must identify gaps in curriculum coverage
  • FR-004: Must verify alignment with educational standards
  • FR-005: Must analyze and validate prerequisite chains

Non-Functional Requirements:

  • NFR-001: Must process curriculum documents within 30 seconds
  • NFR-002: Must support Common Core, NGSS, and custom standards

Permissions:

  • Read: Full repository
  • Edit: curriculum/, docs/learning-objectives/, *.curriculum.md

3.1.2 Instructional Writer Mode

ID: MODE-002
Priority: Critical

Functional Requirements:

  • FR-006: Must analyze content readability
  • FR-007: Must ensure tone consistency across documents
  • FR-008: Must design active learning exercises
  • FR-009: Must evaluate explanation quality
  • FR-010: Must generate formative assessment questions

Non-Functional Requirements:

  • NFR-003: Must support multiple readability metrics (Flesch-Kincaid, SMOG)
  • NFR-004: Must maintain style guide compliance

Permissions:

  • Read: Full repository
  • Edit: lessons/, exercises/, docs/learner/, *.lesson.md

3.1.3 Assessment Developer Mode

ID: MODE-003
Priority: High

Functional Requirements:

  • FR-011: Must validate assessment alignment to objectives
  • FR-012: Must perform item analysis (difficulty, discrimination)
  • FR-013: Must generate rubrics with performance descriptors
  • FR-014: Must detect bias in assessment items
  • FR-015: Must design adaptive assessment logic

Non-Functional Requirements:

  • NFR-005: Must support multiple assessment types (MC, essay, performance)
  • NFR-006: Must calculate statistical indices accurately

Permissions:

  • Read: Full repository
  • Edit: assessments/, quizzes/, rubrics/, *.assessment.md

3.1.4 Content Producer Mode

ID: MODE-004
Priority: High

Functional Requirements:

  • FR-016: Must validate storyboards against objectives
  • FR-017: Must manage media assets with metadata
  • FR-018: Must package content for SCORM/xAPI
  • FR-019: Must validate caption and transcript quality
  • FR-020: Must create interactive content (H5P)

Non-Functional Requirements:

  • NFR-007: Must produce SCORM 1.2 and 2004 compliant packages
  • NFR-008: Must support common media formats (MP4, WebM, PNG, SVG)

Permissions:

  • Read: Full repository
  • Edit: content/, media/, scripts/, *.storyboard.md
  • Browser: Preview and test

3.1.5 Learning Experience Designer Mode

ID: MODE-005
Priority: Medium

Functional Requirements:

  • FR-021: Must map learner journeys
  • FR-022: Must analyze engagement patterns
  • FR-023: Must design gamification elements
  • FR-024: Must architect microlearning structures
  • FR-025: Must generate UI specifications

Non-Functional Requirements:

  • NFR-009: Must support journey visualization
  • NFR-010: Must align gamification to learning objectives

Permissions:

  • Read: Full repository
  • Edit: design/, ux/, *.journey.md, *.spec.md
  • Browser: Prototype and test

3.1.6 Accessibility Auditor Mode

ID: MODE-006
Priority: High

Functional Requirements:

  • FR-026: Must audit WCAG 2.1/2.2 compliance
  • FR-027: Must simulate screen reader experience
  • FR-028: Must analyze color contrast ratios
  • FR-029: Must evaluate cognitive accessibility
  • FR-030: Must provide remediation guidance

Non-Functional Requirements:

  • NFR-011: Must check all WCAG success criteria at A, AA, AAA levels
  • NFR-012: Must prioritize issues by severity

Permissions:

  • Read: Full repository
  • Edit: docs/accessibility/, *.audit.md, a11y-reports/
  • Browser: Screen reader simulation

3.2 Skill Requirements

3.2.1 Skill Architecture

Each skill must:

  • Have a unique identifier (slug)
  • Include a SKILL.md file with description and capabilities
  • Be invocable by one or more modes
  • Return structured results
  • Document limitations and assumptions

3.2.2 Skill Inventory

Skill ID Name Primary Mode Priority
SKILL-001 learning-objective-validator curriculum-designer Critical
SKILL-002 competency-mapper curriculum-designer High
SKILL-003 curriculum-gap-analyzer curriculum-designer High
SKILL-004 standards-compliance-checker curriculum-designer Medium
SKILL-005 prerequisite-analyzer curriculum-designer Medium
SKILL-006 readability-analyzer instructional-writer Critical
SKILL-007 tone-consistency-checker instructional-writer High
SKILL-008 active-learning-designer instructional-writer High
SKILL-009 explanation-quality-checker instructional-writer Medium
SKILL-010 formative-assessment-writer instructional-writer Medium
SKILL-011 assessment-validator assessment-dev Critical
SKILL-012 item-analysis-tool assessment-dev High
SKILL-013 rubric-generator assessment-dev High
SKILL-014 bias-detector assessment-dev Medium
SKILL-015 adaptive-logic-designer assessment-dev Medium
SKILL-016 storyboard-validator content-producer Critical
SKILL-017 media-asset-manager content-producer High
SKILL-018 scorm-packager content-producer High
SKILL-019 caption-quality-checker content-producer Medium
SKILL-020 interactive-content-builder content-producer Medium
SKILL-021 journey-mapper lx-designer Critical
SKILL-022 engagement-analyzer lx-designer High
SKILL-023 gamification-designer lx-designer High
SKILL-024 microlearning-architect lx-designer Medium
SKILL-025 ui-spec-generator lx-designer Medium
SKILL-026 wcag-compliance-checker accessibility-auditor Critical
SKILL-027 screen-reader-simulator accessibility-auditor High
SKILL-028 color-contrast-analyzer accessibility-auditor High
SKILL-029 cognitive-accessibility-checker accessibility-auditor Medium
SKILL-030 remediation-advisor accessibility-auditor Medium

3.3 Interface Requirements

3.3.1 Mode Configuration Interface

Each mode configuration must include:

  • name: Display name
  • slug: Unique identifier
  • roleDefinition: Detailed role description
  • whenToUse: Usage guidance
  • permissions: File and command restrictions
  • customInstructions: Mode-specific behavior rules

3.3.2 Skill Interface

Each skill must include:

  • name: Display name
  • description: Capability description
  • capabilities: List of specific capabilities
  • usage: When and how to use the skill

3.4 Integration Requirements

3.4.1 Mode Handoffs

From Mode To Mode Handoff Content
curriculum-designer instructional-writer Learning objectives, course structure
instructional-writer content-producer Scripts, content outlines
lx-designer content-producer Interactive element specifications
assessment-dev all modes Assessment requirements
all modes accessibility-auditor Content ready for review

3.4.2 Skill Sharing

Skills may be shared between modes where capabilities overlap:

  • readability-analyzer can be used by content-producer
  • assessment-validator can be used by instructional-writer
  • wcag-compliance-checker can be used by content-producer

4. Non-Functional Requirements

4.1 Performance

  • NFR-013: Mode switching must complete within 5 seconds
  • NFR-014: Skill invocation must complete within 30 seconds
  • NFR-015: File operations must respect permission boundaries

4.2 Reliability

  • NFR-016: Modes must not crash on invalid input
  • NFR-017: Skills must return structured error messages
  • NFR-018: Configuration errors must be reported clearly

4.3 Security

  • NFR-019: File permissions must be enforced
  • NFR-020: Modes must not access files outside their scope
  • NFR-021: Skills must not execute arbitrary commands

4.4 Maintainability

  • NFR-022: All configurations must be version-controlled
  • NFR-023: All skills must be documented
  • NFR-024: Changes must be tracked in CHANGELOG.md

5. Acceptance Criteria

5.1 Mode Acceptance

  • All 6 modes are configured correctly
  • All XML instruction files are well-formed
  • File permissions are enforced
  • Mode handoffs work as specified
  • Documentation is complete and accurate

5.2 Skill Acceptance

  • All 30 skills are documented
  • Skills return structured results
  • Skills handle errors gracefully
  • Skills integrate with parent modes
  • Shared skills work across modes

5.3 Integration Acceptance

  • End-to-end workflows complete successfully
  • No permission conflicts occur
  • All test scenarios pass
  • Performance requirements are met
  • Security requirements are met

6. Appendices

6.1 Bloom's Taxonomy Reference

Level Verbs Description
Remember list, define, identify, recall Recall facts and basic concepts
Understand explain, describe, summarize, interpret Explain ideas or concepts
Apply use, solve, demonstrate, implement Use information in new situations
Analyze compare, contrast, differentiate, examine Draw connections among ideas
Evaluate judge, critique, justify, defend Justify a stand or decision
Create design, construct, produce, develop Produce new or original work

6.2 WCAG 2.1 Principles

  1. Perceivable: Information must be presentable in ways users can perceive
  2. Operable: User interface components must be operable by all users
  3. Understandable: Information and UI operation must be understandable
  4. Robust: Content must be robust enough for various assistive technologies

6.3 SCORM Versions

Version Year Key Features
SCORM 1.2 2001 Basic sequencing, simple data model
SCORM 2004 2004 Advanced sequencing, shared state

6.4 Implementation Status

As of 2026-04-24:

Component Required Implemented Status
Modes 6 6 Complete
Mode Config Files 6 6 Complete
XML Rule Files 42 42 Complete
Skills 30 30 Complete
SKILL.md Files 30 30 Complete
Documentation 11 11 Complete

Total Files Created: 125

6.5 File Inventory

Root Documentation

  • README.md - Project overview and quick start guide
  • CHANGELOG.md - Version history with detailed change log
  • AGENTS.md - Agent configuration and behavior guidelines

Documentation (docs/)

  • plan.md - Development plan with 4 phases and milestones
  • srs.md - Software Requirements Specification
  • support-team-guide.md - Installation, troubleshooting, and extension guide for support teams
  • user-guide.md - User guide with conceptual intro, mode usage tips, and workflow optimization
  • plan-ES.md - Spanish version of development plan
  • srs-ES.md - Spanish version of SRS
  • support-team-guide-ES.md - Spanish version of support team guide
  • user-guide-ES.md - Spanish version of user guide

Modes (modes/)

Each mode contains:

  • mode-config.yaml - Mode configuration with permissions
  • rules/1_workflow.xml - Primary workflow definition
  • rules/2_best_practices.xml - Best practices and guidelines
  • rules/3_common_patterns.xml - Common design patterns
  • rules/4_decision_guidance.xml - Decision-making guidance
  • rules/5_examples.xml - Worked examples
  • rules/6_error_handling.xml - Error handling procedures
  • rules/7_communication.xml - Communication and handoff protocols

Skills (skills/)

Each skill contains:

  • SKILL.md - Skill documentation with YAML frontmatter including:
    • name - Skill identifier
    • description - Capability description
    • Capabilities section
    • Usage guidelines
    • Input/Output specifications
    • Limitations and assumptions