CSC/ECE 517 Spring 2013/Final E728

Final Project E728

Design Document

Introduction

The E728 project focuses on improving the review section's layout and usefulness. <ref name='assignment'> https://docs.google.com/document/d/11YTjxFXFR13vJ769yFBbqn9qOueK2Ktz0Pd-gyS2W5U/edit</ref> Our plan is to breakdown the assignment and address each goal.

1. Tabular Reviews - Use a table with tabs to view the reviews. The tabs will select which review is active. The table will hold the questions on the left, and corresponding reviewer score and comment on the right.
2. Submission Type Indicator - A visual clue (can be either text message, color coded, or image icon) will be added to distinguish if a review is an original or updated review.
3. Bug Fix - Figure out if a particular bug still exists, if so fix it. The bug happens when a one clicks on a particular review and it does not display the feedback form the review.
4. Meta-review Relations - Create a link or add text to indicate which review the meta-review was written about.
5. Update View Scores - Improve the view scores page by adding filters.
6. Restructure HTML Generation - Move as much code that generates HTML from the models to the views.

Goal Mock-Ups

Tabular Reviews

The current review page is shown below. A mock-up of the planned changes is also shown below.

Before

After (mock-up)

Notice that the reviews have moved from sequential listing to displaying one at a time in a table. The other views can be seen by clicking their respective link which might be styled as a 'tab'.

Submission Indicator

One option is to color code the review links to indicate an updated review. In the mock-up below the updated link is green. A key will be needed to inform users of the distinction.

Color-coding (mock-up)

Meta-review Relations

A summary of the review's information can be displayed below the review. The image below shows some information that may be useful including the source of the meta-review.

Color-coding (mock-up)

Design Goals

Most of the design patterns are difficult to apply since we will be focusing on the views only and not gathering and structuring the data. From what we can tell the data is already there and sent to the view. We should not need to edit the models or controllers much, except for goal 6 (Restructure HTML Generation). In any case we expect to stay DRY, and comment our code for easy understanding and future integration. We will adhear to the MVC architecture and as such will add the necessary code to its correct position.

References

<references/>