E1735. UI changes for review and score reports

Introduction

This wiki provides details on the tasks that were undertaken as part of the continuous improvement to the Expertiza project.

Background

Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). The Expertiza project is supported by the National Science Foundation.

The application provides a complete system through which students and instructors collaborate on the learning objects as well as submit, review and grade assignments for the courses.

Motivation

By participating in the overall refactoring effort as part of the continuous improvement of Expertiza, students get an opportunity to work on a open source software project. This helps them gain exposure on the technologies used in the project as well as much needed experience in collaborating with peers as part of the software development process.

Requirements Statement

Expertiza displays reviews (i) to the team who was reviewed, and (ii) to the reviewer. A student user can see all the reviews of his/her team’s project. The instructor can see all the reviews of everyone’s project. The instructor also has access to a Review report, which shows, for each reviewer, all the reviews that (s)he wrote. Currently, the score report and reviewer report use completely different code. This makes the UI non-orthogonal and also causes DRY problems. So, we would like to have a single way of displaying reviews that would be visible to students (reviews that they did, and reviews that their team received), and instructors (reviews that each time received, sorted by team; and reviews that each student did, sorted by student).

Tasks

The tasks involved as part of this requirements change are as follows:

1. Compact the review display
   • Eliminate the blank lines between items within a single review. Instead vary the background color from line to line to improve readability
   • With a single click, there should be a way to hide all the reviews, reveal just the headings (as at present), or expand all the reviews
2. At the top of each review, it should say
   • Who submitted the review. The instructor should see the user’s name and user-ID.
   • A student should see
     • “Reviewer #k”, where k is an integer between 1 and n, the number of reviews that have been submitted for this project
     • The version number of the review
     • The time the review was submitted
3. There should be a tabbed view to switch between various review views
   • One tab has overall statistics (averages, min, max, as the present “normal” view)
   • One tab has the heat map (current “alternate” view)
   • One tab has a grid view, with no scores, but text comments in the grid squares, and then a “More” link to display the whole comment (which will require expanding the row of the grid)
   • Switching between reviews from Reviewer k and Reviewer j might also be done by clicking on different tabs. Or, it might be more convenient to keep the current score view, which lists the n reviews across the page. Then the student should be able to click on the reviewer number (the instructor would instead click on the reviewer name) and see the review done by that reviewer
4. To make it easy to focus on the reviewer’s feedback, there should be a way to hide and/or gray the criteria (“questions”), so the responses stand out more clearly
5. There needs to be a way to search all reviews (of a particular project, or by a particular individual) for a given text string. The user should be able to go from one instance of the text string to another by clicking down and up buttons