Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

These are requirements for the RethinkEd authoring tool that allows users to create a variety of question types for educational activities. The focus is on the user interface, interaction flow, and validation process necessary for creating Single Page and Facing Pages items.

Figma

https://www.figma.com/file/hq6VjWO99WfQaSzXswgVIY/Authoring?type=design&node-id=1950%3A44451&mode=design&t=ovJcCdAuua52Np8r-1

Epic

Feature 193009: Activities Builder | SEL Authoring

UI Description

  1. Main Interface:

    • A central workspace where item authoring occurs, featuring a clear and uncluttered layout to promote focus and ease of use.

  2. Item Creation Button:

    • A prominent plus button allows users to initiate the creation of new items.

  3. Item Type:

    • Description: Upon selecting to create a new item, a dropdown menu appears, offering a selection of item types.

    • Required: Yes

    • Type of Input: Dropdown Menu

    • Dropdown values (single-select):

      • Multiple Choice

      • Interactive Worksheet

      • Single Page

      • Facing Pages

      • True/False

      • Multiple Select

  4. Prompt

    • Description: Area for user to enter a prompt description or question.

    • Required: Yes

    • Type of Input: WYSWYG Text Editor

  5. Attach Resource

    • Description: Button opens the Add Resource modal for the user to attach a resource to the prompt field.

    • Required: No

    • Type of Input: Button

  6. Conditional UI Elements:

    • Additional options or fields dynamically appear based on the selected item type.

User Interaction and Validation Notes

  • Creating an Item:

    • Users begin by clicking the plus button and choosing "Item" from the presented options.

  • Selecting Item Type:

    • From the dropdown menu, users select the desired item type, triggering the UI to update with relevant input fields.

  • Input Validation:

    • The prompt fields are mandatory fields, and the system performs real-time validation to ensure required information is entered before saving.

    • For Single Page items, a single prompt input field with a WYSWYG editor is available.

    • For Facing Pages items, two prompt input fields with a WYSWYG editor are available.

    • It is optional to attach a resource to a prompt or answer choice.

  • Attach Resource

    • Upon selecting a resource to attach to a prompt field or answer choice field, the user should be able to select from a dropdown menu the location of the image in relation to the displayed text.

      • Above

      • Below

      • Right aligned

      • Left aligned

  • Saving Items:

    • A "Save" button commits the created item to the activity. The button becomes active only when all required fields are satisfactorily completed.

Workflow Description

  1. Initiate Item Creation:

    • The user clicks the plus button and selects "Item" to start the authoring process.

  2. Select Item Type:

    • The user chooses an item type from the dropdown menu, which updates the UI to display appropriate input fields for the selected item type.

  3. Enter Item Details:

    • For Single Pages and Facing Pages item types, the user fills in prompts.

  4. Attach Resource:

    • The user selects Attach Resource button to open the Add Resource modal and select a resource to be attached to the prompt field. It is optional to attach a resource to a prompt.

  5. Finalization:

    • Upon entering all necessary information and passing validation checks, the user clicks "Save" to add the item to the activity. For items with optional explanations, inputting text is at the user's discretion.