E1875 Revision Planning Tool: Difference between revisions

From Expertiza_Wiki
Jump to navigation Jump to search
No edit summary
 
(27 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<br/>
<br/>
== What's it about? ==
== What's it about? ==
In the first round of Expertiza reviews, we ask reviewers to give authors some guidance on how to improve their work.  Then in the second round, reviewers rate how well authors have followed their suggestions.  We could carry the interaction one step further if we asked authors to make up a revision plan based on the first-round reviews.  That is, authors would say what they were planning to do to improve their work.  Then second-round reviewers would assess how well they did it.  In essence, this means that authors would be adding criteria to the second-round rubric that applied only to their submission.  We are interested in having this implemented and used in a class so that we can study its effect.
In the first round of Expertiza reviews, we ask reviewers to give authors some guidance on how to improve their work.  Then in the second round, reviewers rate how well authors have followed their suggestions.  We could carry the interaction one step further if we asked authors to make up a revision plan based on the first-round reviews.  That is, authors would say what they were planning to do to improve their work.  Then second-round reviewers would assess how well they did it.  In essence, this means that authors would be adding criteria to the second-round rubric that applied only to their submission.  We are interested in having this implemented and used in a class so that we can study its effect.  


<br/>
<br/>
Line 10: Line 10:
*** How effectively did feature X address / solve issues a, b and c?
*** How effectively did feature X address / solve issues a, b and c?
*** Did modification of feature Y resolve error d?
*** Did modification of feature Y resolve error d?
* Every new question must be linked to the second-round questionnaire.
* The new questionnaire must be linked to the second-round questionnaire.
* Every new question must be linked to the author’s submission
* The new questionnaire must be part of the team's submission records.


<br/>
<br/>
== Problem Statement ==
== Problem Statement ==
In the 2nd round of reviews, the Author should be able to add a statement to direct towards Author selected improvements from Round 1 to Round 2.
In the 2nd round of reviews, the Author should be able to add a statement to direct towards Author selected improvements from Round 1 to Round 2.
Line 22: Line 23:
* Questions unique to each project gives the reviewers a perspective on the author’s objectives.
* Questions unique to each project gives the reviewers a perspective on the author’s objectives.
* Allow the Author to get feedback on whether or not they accomplished their self-directed goal.
* Allow the Author to get feedback on whether or not they accomplished their self-directed goal.
This project has been extended and reworked under Independent Study in Spring 2019.
<br/>


<br/>
== Criteria for completion ==
== Criteria for completion ==
# Direct user to Revision Improvement Questionnaire.
# Direct user to Revision Planning Questionnaire.
# Create a form for a Assignment Team to add Questions to a Questionnaire that are specific to that Submission.
# Create a form for the Assignment Team to add Questions to a Questionnaire that are specific to that Submission in the second round of submission.
# Append Revision Improvement Questionnaire to 2nd Round Review Questionnaire.
# Append Revision Planning Questionnaire to 2nd Round Review Questionnaire.


<br/>
<br/>
== Implementation Plan ==
 
<br/>
 
=== Files to be modified ===
==== Questionnaire ====
* questionnaire_controller.rb
* questionnaire.rb
* author_review_questionnaire.rb ( doesn’t exist, needs to be created and named appropriately )
* questionnaires/*.erb
<br/>
==== Submitted Content ====
* submitted_content_controller.rb
* submission_record.rb
<br/>
=== UI mockups ===
=== UI mockups ===
The first image shows a mockup of what the Author will see on the submission page to submit new additional questions for review.
The first image shows a mockup of what the Author will see on the submission page to submit new additional questions for review. <br/>
[[File:E1875U1_1.jpg|100px|Image: 100px]]
[[File:E1875U1_1.jpg]]<br/>
Second is a view of what the reviewer will see. It should blend in with the review questions submitted by the instructor for all similar projects.
Second is a view of what the reviewer will see. It should blend in with the review questions submitted by the instructor for all similar projects.<br/>
[[File:E1875U1_2.jpg|100px|Image: 100px]]
[[File:E1875UI_2.jpg]]
<br/>
<br/>
<br/>
<br/>
== Files modified ==
==== Controllers ====
* [https://github.com/expertiza/expertiza/pull/1456 questionnaires_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1456/commits/2bd9590d18b56d0fcc8850f729a00370cd23190f response_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1456/commits/2bd9590d18b56d0fcc8850f729a00370cd23190f submitted_content_controller.rb]
==== Views ====
* [https://github.com/expertiza/expertiza/pull/1456/commits/2bd9590d18b56d0fcc8850f729a00370cd23190f questionnaires/_questionnaire.html.erb]
* [https://github.com/expertiza/expertiza/pull/1456/commits/9bc76076b1739f2d2ddaff74782ea6f1a046f38a submitted_content/edit.html.erb]
* [https://github.com/expertiza/expertiza/pull/1456/commits/9bc76076b1739f2d2ddaff74782ea6f1a046f38a submitted_content/edit.html.erb]
==== Models ====
* [https://github.com/expertiza/expertiza/pull/1456/commits/2bd9590d18b56d0fcc8850f729a00370cd23190f questionnaire.rb]
* [https://github.com/expertiza/expertiza/pull/1456/commits/2bd9590d18b56d0fcc8850f729a00370cd23190f response.rb]
==== Database ====
* [https://github.com/expertiza/expertiza/pull/1456/commits/2bd9590d18b56d0fcc8850f729a00370cd23190f schema.rb]
==== Specs ====
* [https://github.com/expertiza/expertiza/pull/1456/commits/2bd9590d18b56d0fcc8850f729a00370cd23190f questionnaires_controller_spec.rb]
==== config ====
* [https://github.com/expertiza/expertiza/pull/1456/commits/9bc76076b1739f2d2ddaff74782ea6f1a046f38a routes.rb]
== Test Plan and Demo ==
=== Test Plan ===
=== Test Plan ===
# Authors should be able to add additional review questions to their submission.
# Login as 'super_administrator2' with password 'password'.
# Reviewers should be able to give feedback according to the review question written by the author.
# Make an assignment with the name 'Assignment1'.
# Authors should be able to view the feedback given on the questions they wrote.
# Make the following selections:
# ''Stretch'': Instructors should be able to set requirements on the number of additional review questions authors are required to add.
## Review Strategy: Allow authors to add to rubric.
## Rubric: Rubric varies by round.
## Add participants: Add existing students - student1, student2
## Due Dates: Add deadlines for rounds.
## Add topics to the assignment
# Set 2 rounds of submissions and reviews.
# Impersonate student1.
# Signup for topic and form team.
# Make submissions in round 1 submission.
# Move to round 1 review stage.
# Impersonate student2.
# Make submissions in round 1 and review it.
# Move to round 2 submission stage
# Impersonate student1.
# Submit a revision plan in the 'Your Work' handle.
# Repeat above two steps for student2.
# Move to round 2 review.
# Impersonate student2.
# Verify that revision plan questions are added to the review by student1'team and submit the review.
# impersonate student1.
# Repeat the above two steps for student1.
# Verify that review has been received on the revision plan questions after assignment is finished.
 
===Demo Video===
 
*[https://www.youtube.com/watch?v=t11JQUEqUKg&feature=youtu.be Demo Video]

Latest revision as of 17:09, 8 May 2019


What's it about?

In the first round of Expertiza reviews, we ask reviewers to give authors some guidance on how to improve their work. Then in the second round, reviewers rate how well authors have followed their suggestions. We could carry the interaction one step further if we asked authors to make up a revision plan based on the first-round reviews. That is, authors would say what they were planning to do to improve their work. Then second-round reviewers would assess how well they did it. In essence, this means that authors would be adding criteria to the second-round rubric that applied only to their submission. We are interested in having this implemented and used in a class so that we can study its effect.


What needs to be done?

  • Develop UI for authors to create new questions to add to the second round-rubric. This should be a form that includes the following:
    • A description of the revision plan. Eg: We will add feature X to address issues a,b and c. We will modify feature Y and expect it to resolve errors d, c and e.
    • One or more questions for every proposed improvement. Example:
      • How effectively did feature X address / solve issues a, b and c?
      • Did modification of feature Y resolve error d?
  • The new questionnaire must be linked to the second-round questionnaire.
  • The new questionnaire must be part of the team's submission records.


Problem Statement

In the 2nd round of reviews, the Author should be able to add a statement to direct towards Author selected improvements from Round 1 to Round 2.


Motivation

The OSS and Final projects are different for every team. From a reviewers perspective, not all questions make sense for all projects. The motivation behind this project is:

  • Questions unique to each project gives the reviewers a perspective on the author’s objectives.
  • Allow the Author to get feedback on whether or not they accomplished their self-directed goal.

This project has been extended and reworked under Independent Study in Spring 2019.

Criteria for completion

  1. Direct user to Revision Planning Questionnaire.
  2. Create a form for the Assignment Team to add Questions to a Questionnaire that are specific to that Submission in the second round of submission.
  3. Append Revision Planning Questionnaire to 2nd Round Review Questionnaire.



UI mockups

The first image shows a mockup of what the Author will see on the submission page to submit new additional questions for review.

Second is a view of what the reviewer will see. It should blend in with the review questions submitted by the instructor for all similar projects.


Files modified

Controllers

Views

Models

Database

Specs

config

Test Plan and Demo

Test Plan

  1. Login as 'super_administrator2' with password 'password'.
  2. Make an assignment with the name 'Assignment1'.
  3. Make the following selections:
    1. Review Strategy: Allow authors to add to rubric.
    2. Rubric: Rubric varies by round.
    3. Add participants: Add existing students - student1, student2
    4. Due Dates: Add deadlines for rounds.
    5. Add topics to the assignment
  4. Set 2 rounds of submissions and reviews.
  5. Impersonate student1.
  6. Signup for topic and form team.
  7. Make submissions in round 1 submission.
  8. Move to round 1 review stage.
  9. Impersonate student2.
  10. Make submissions in round 1 and review it.
  11. Move to round 2 submission stage
  12. Impersonate student1.
  13. Submit a revision plan in the 'Your Work' handle.
  14. Repeat above two steps for student2.
  15. Move to round 2 review.
  16. Impersonate student2.
  17. Verify that revision plan questions are added to the review by student1'team and submit the review.
  18. impersonate student1.
  19. Repeat the above two steps for student1.
  20. Verify that review has been received on the revision plan questions after assignment is finished.

Demo Video