My Classes widget

Target release

Type // to add a target release date

Epic

Type /Jira to add Jira epics and issues

Document status

DRAFT

Document owner

@ mention owner

Designer

@ designer

Tech lead

@ lead

Technical writers

@ writers

QA

 

 Objective

To provide a user a means to access the classes to which belongs to, showing their details in selectable blocks.

 Success metrics

Goal

Metric

Goal

Metric

To have each Class detailed in its own selectable block.

For teachers, the block should present:

  • Class Name

  • Class Alias

  • Class Level

  • Number of students in it

  • Start/End dates

  • Class Code

For students, the block should present the same as for teachers except for the Class Code, which should be not present in the DOM.

Each block should link to the appropriate Class.

On click/tap, the user should land in the Class Materials area corresponding to the selected class.

Teachers have a Search field.

It should be possible to search a Class by name, alias, code.

Teachers have a Grade filter

When applied, the classes listed should belong all to the selected grade.

Students have an Add Class field

Students should be able to add a new Class by entering its Code in the field and hitting <ENTER> when the cursor is in it, or clicking in the “+Add” button.

 Assumptions

  • Classes are correctly configured with the appropriate grade.

 Requirements

Requirement

Importance

Notes

Requirement

Importance

Notes

HIGH

 

 User interaction and design

Student view
Teacher view

If there is no Class to show, the widget is to collapse its height to the level at which the first Class block should start to appear. This can happen when the user has no Class, when the Search presents no results, or when there is no Class in the selected Grade.

The Search function is to run when the users hits <ENTER> and not on-type. This is to avoid concurrent searches and workload.

The Grade filter is to present all 4 possible grades (preschool, primary, secondary, adults) always, regardless of if the school has them or not. This is to avoid a call to DB to consult the existing levels of a school.

 

 Open Questions

Question

Answer

Date Answered

Question

Answer

Date Answered

How does a student enter a class?

To enter a class, the teacher must provide the class code to the student, and the student should register it in "+ Add."

Where can the class code be found?

When creating a class, the code is generated automatically, and each class has a unique code.

 

 

 Out of Scope

  •  

Related pages