View source for CSC/ECE 517 Fall 2015/E1584 Send Feedback to Support

'''E1584. Send Feedback to Support'''

This is the design document for the Feedback to Support feature of Expertiza. This goal of this 
==Project==

=== Introduction to Expertiza ===
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides an incremental class based learning together with the instructors and the peers. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza handles assignment submissions, team formations, assignment reviews and grades, etc.

=== Purpose ===
During reviews, many times reviewers will be having questions about the submitted material and if it's a blocker there is no way that the reviewer can progress further with the review.  As a result, reviewers will end up submitting the empty or incomplete review.

=== Scope ===
This project is limited to an email based conversation for asking questions and answers. The reviewers would ask questions related to assignment submission doubts to which authors can respond. All this would be taken care as email responses using a link provided in the email. This project does not cater to any live interactive session with spontaneous back-to-back questions and responses.

Following tasks would be incorporated in the project:
* Provide a ‘TextArea’ input field on review forms, where any reviewer can type in their questions.
* Create a new button ‘Ask for Quick Help’ on the review forms.
* An email would be send to the author with the link where he can respond to the questions asked by the reviewers for their submitted work.
* Reviewers would be notified by an email when authors respond to the the questions.

== Design ==

=== Discussion of Resolution ===

We will make the following modifications to implement the chat feature:- <br>

*Create a new model which will help extract,store and validate data in the database table which contains information about the interaction between the author/s and reviewer.

*Edit the view which is used by the response controller to incorporate the text area input field on the review form where the reviewer can ask his/her initial query.

*Create a new controller which will contain methods to send emails to the author and reviewers as well as retrieve and display the chat history between the two.

*Create a new view which will facilitate the author to respond to the queries asked by the reviewer. The reviewer can also use this view to ask any follow up questions.

=== Mock-Ups ===
The sample question box would look like:

[[File: ARSNMockup1.JPG]]

An interface with the question would be displayed on opening a link from the email.
The authors can reply the query which reviewers ask.

[[File: ARSNMockup2.JPG]]

=== Design Patterns ===
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum

=== Database Design ===

[[File:DatabaseTable.jpg]]

The above figure shows the schema of a new table which will be created in Expertiza to store relevant information about the chat. It contains the following attributes:
* id: This attribute is auto-generated by rails when we create a table and is auto incremented with each record. It is also the primary key of our table.
* assignment_id: Stores the ID of the assignment for which the interaction between author and reviewer is taking place.
* reviewer_id: Stores the ID of the reviewer who asks the questions.
* team_id: Stores the ID of the team to which the topic belongs.
* type_flag: Flag which is used to indicate if the particular tuple contains a question or answer. It can take two values, 'Q' for question and 'A' for answer.
* content: Stores the question asked by the reviewer or the response given by the author/s depending on the value of the type flag.

Records for a particular interaction can be identified by using a combination of assignment_id, reviewer_id and team_id.

=== Use Cases ===
'''Name:''' Send a question to the author/s about their work.<br>
'''Actor:''' Reviewer. <br>
'''Description:''' The reviewer enters his question in the text area which is provided and clicks on the "Ask question" button which is provided as shown in the mock up. On clicking this button an email is sent to the author/s along which a link to answer the question.<br>
<br>
'''Name:''' Answer the question which has been asked by the reviewer.<br>
'''Actor:''' Author/s<br>
'''Description:''' The author/s click on the link received in their email and are redirected to a page where they can answer the question. Once they submit the answer, an email is sent to the reviewer notifying him/her that their question has been answered.<br>

=== Proposed Tests ===
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum

== Implementation ==

'''Files created/modified:-'''

*Create a new model chat_feedback.rb 

*Create a new controller review_interactions_controller.rb

*Create new views as discussed in the design.

*Modify view expertiza/app/views/response/response.html.erb to incorporate text box and corresponding submit button.

'''Flow:-'''

*The reviewer enters his question in the text area provided and clicks on the "Ask Question" button.
*On clicking this button the appropriate method is called in review_interactions_controller.rb which sends an email to all the authors of the topic indicating that a question has been asked about their work. The email contains a link which when clicked on will redirect the author to the appropriate view where he/she can answer the question.
*On answering the question, the reviewer receives an email indicating that his question has been answered. It also contains a link which redirects the reviewer to the appropriate view where the answer will be displayed.
*This view also contains the chat history between the author/s and the reviewer for the entire duration of the interaction.

== Suggestions for Future Improvements ==

* This can be extended to a live interactive author-reviewer anonymous chat session inside the Expertiza reviews window.
* A purging script can be developed which will clear all the interaction records every semester.

==Resources==

* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref>

==References==
<references/>