Skip to content

Latest commit

 

History

History
85 lines (52 loc) · 4.77 KB

Manual.md

File metadata and controls

85 lines (52 loc) · 4.77 KB

Manual

Tweetable is a platform for a teacher and student where a teacher gives an exercise which students have to attempt in the given time.


Terminology

Exercise

      It is a paragraph which is the main part of the exercise.

Response

      It is an answer given by the student to the exercise. Also known as Tweet because of the 140 character limit.

Commence time

      A time when an exercise will be available to the students to attempt it.

Conclude time

      A time when an exercise will no longer be available to the students.

Commenced

      All the available exercises to attempt.

Attempted

      The exercises which are attempted by the students.

Missed

      The exercises which are missed by the students and can not be attempted by them.

Tag

      A grade given to a student on his/her response is known as a tag. Each tag has a weight which is the basis of the points given in leader board. Additionally, a tag has a custom color and description.

Duration

      Time duration in which student have to attempt the exercise. Failing in that will be marked as missed for that student.

Leader Board

      A leader board which shows the position of a student among their batch.

Commence

      Gives an exercise to the students right away.

Conclude

      Closes an exercise for the students immediately.

New

      Create a draft for the exercise which requires title, exercise and time duration.

Drafts

      The drafted exercises which are not yet available to the students.

Ongoing

      All the ongoing exercises which are opened for the students to attempt.

Concluded

      All the exercises which are attempted by students and are no longer available for them to attempt.


Admin Guide

Creating a exercise - For creating an exercise, go to New section in the side menu. Enter the details title, exercises and duration. You can also provide commence time and conclude, however you can proceed without time.

Commencing a exercise - The exercises in drafts have a Commence feature. This feature comes handy when you want to give exercise right away. It will ask a conclude time which is necessary.By default, the conclude time is two days from the current time. This action will move the exercise to ongoing section.

Concluding a Exercise - The exercises which are ongoing can be concluded at any time. This feature meant to be used wisely because it concludes the exercise before the given time. It will immediately conclude the exercise and move it to Conclude section. A case will be when an admins find that there are enough responses.

Evaluating Responses - While the exercise is ongoing or concluded an admin can review the responses. The reviewing mechanism is straight forward an admin gives a tag to a response. Tag's color, weight and description can be modified in the tags section. An example of a tag could be #concise #grammar mistake etc...

Adding Users - For adding a user, go to Users section and add their emails. They will be added as an active user and will be displayed in the user list.All other details will be updated once they login.

Making User Active/Admin - In Users section by enabling on the checkbox an admin can make any user active/inactive or admin. A user which log's in without admin adding him will be inactive by default. An inactive user can not access the feature of the app unless he/she is made active by the current admin. An admin can not change his/her role.


Student Guide

Attempting a exercise - In commenced section, all the exercises visible are to be attempted by the student. The title of the exercise with conclude time and duration will only be visible. The conclude time is the time when the exercise will no longer available to attempt. However, an admin can conclude it at any time. Once a student starts attempting, he/she will get the exercise with a duration timer. Failing to honor the time exercise will be moved to the missed section. Note, A tweet can not be undone once it is submitted.

See the Evaluation - The evaluation will be in the form of tags which will be available on the exercises in attempted section. A student can view responses of all the people who responded to that exercise. The evaluation will be in the form of a tag. A Student can view all the information related to the exercise which is attempted and missed by him/her.

Positions on the Leader Board - A student can see his/her ranking on the Leader Board. The scores are calculated by the tag weights got by the student.