Changes between Version 106 and Version 107 of UserDoc


Ignore:
Timestamp:
2010-08-30T20:44:04Z (14 years ago)
Author:
Serge Okon
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • UserDoc

    v106 v107  
     1                                 
    12[[PageOutline(2-7, Table of Contents, floated)]]
    23
     
    45(Created August 2010)[[br]]
    56
    6 iPeer is an application to develop and deliver rubric-like peer evaluations, to review and release student comments, to build progress report forms online, and to analyze evaluation results. It has extensive features including user management system, student feedback control, data import/export, automatic installer, self-evaluation and etc…
     7iPeer is an application to develop and deliver rubric-like peer evaluations, to review and release student comments, to build progress report forms on-line, and to analyze evaluation results. It has extensive features including a user management system, student feedback control, data import/export, automatic installer, self-evaluation and etc…
    78(from: http://ipeer.apsc.ubc.ca/home/?page=about)
    89
    910==== Technical Information ====
    1011iPeer is a Web Application. This means that it runs on a server, and can be accessed with any web browser.[[br]]
    11 iPeer is written in a web programming language PHP (http://www.php.net) and uses a framework called CakePHP. (http://www.cakephp.org) to structure its code.
     12iPeer is written in a web programming language called PHP (http://www.php.net) and uses an application framework called CakePHP. (http://www.cakephp.org) to structure its code.
    1213For more technical details, please see iPeer's Trac website at http://burrito.olt.ubc.ca/trac/
    1314
     15There are 3 types of users in iPeer: students, instructors, and administrators.
     16
    1417=== Students ===
    15 The students interface is focused on completing evaluations. After students have been created, and assigned to courses, they can log into the system, and complete evaluation events.
     18The students interface is focused on completing evaluations. After students have been created they can log into the system, and after they have been assigned to courses they can complete evaluation events.
    1619
    1720==== Login for Students ====
    1821Students can log in via 2 mechanisms:
    19  * via username and password, like every other user on the system.
     22 * via username and password, like every other type of iPeer user.
    2023 * via the CWL plug-in (for University of British Columbia (UBC)).
    21   * Note that if CWL plug-in is enabled, the students cannot login via iPeer's username and password, and must use their CWL login.
     24  * Note that if CWL plug-in is enabled, the students cannot login via iPeer's username and password, and must always use their CWL login.
    2225
    2326===== iPeer Login for Students =====
    2427The students login with their username and password.
    2528 * Username: enter your student number.
    26  * Password: enter the password given to you by your instructor or TA. You can update it later.
     29 * Password: enter the password given to you by your instructor or TA. You can update your password later.
    2730Click the login button to complete the login process.
    2831
     
    3841
    3942==== Home Page ====
    40 When a students logs in, they are presented with the home page. Student's view of iPeer is focused on submitting evaluations assigned by thier instructors.[[br]]
     43When a students logs in, they are presented with the home page. Student's view of iPeer is focused on submitting evaluations assigned by their instructors.[[br]]
    4144This page contains 2 sections, both listing evaluation events:
    4245
     
    4750||Evaluation 1||COMP 101 101||Sun, Sep 5, 2010 11:55 am||30 day(s)||
    4851
    49 To complete an evaluation, just clink on its title. So, to complete the above event, you would click on "Evaluation 2".
     52To complete an evaluation, just click
     53  x  on its title. So, to complete the above event, you would click on "Evaluation 2".
    5054
    5155===== Peer Evaluations Submitted =====
     
    5458
    5559||'''Event'''||'''Course'''||'''Due Date'''||'''Date Submitted'''||
    56 ||Evaluation 1||home COMP 101 101||Sun, Sep 5, 2010 11:55 am||Fri, Sep 3, 2010 9:25 am||
    57 
    58 
    59 If you want to see your answers for this evaluation, click on its title. A new window or tab will pop up, with the evaluation answers, and results, if they were released.
     60||Evaluation 1||home COMP 101 101||Sun, Sep 5, 2010 11:55 am||Fri, Sep 3, 2010 9:25 am
     61
     62If you want to see your answers for this evaluation, click on its title. A new window or tab will pop up, with the evaluation answers and results (if they were released by your instructor).
    6063
    6164==== Filling out Evaluations ====
    6265
    6366There are 3 types of evaluations in iPeer: Simple Evaluations, Rubrics, and Mixed evaluations.
    64 After clicking on an evaluation name, the selected evaluation will open:
     67After clicking on an evaluation name, the selected evaluation will open.
    6568
    6669===== Simple Evaluations =====
    6770[[Image(documentation-simpleEvalExample1.png, 240px, align=right, border=3)]] 
    6871Simple evaluations are the most basic evaluation types in iPeer. They consist of a set number of points to distribute among your team members.
    69 The following instructions appear on the evaluation page itself, and this manual will expand on each of the point state:
     72The following instructions appear on the evaluation page itself, and this manual will expand on each of the points:
    7073
    7174 1. Rate your peer's relative performance by using the slider. [Weight 1-10]
    72   * iPeer has an semi-automatic system for distributing points with amongst your team members. Slide each of the orange sliders to evaluate your team members relative to one another. This will assign them "slider-points".
     75  * iPeer has a semi-automatic system for distributing points with amongst your team members. Slide each of the orange sliders to evaluate your team members relative to one-another. This will assign them "slider-points".
    7376 2. Click "Distribute" button to distribute points.
    74   * iPeer will calculate the percentage of "slider-points" you assigned to each of your teammates, and will then calculate how many real points each is given. For example, the evaluation has 200 Real Points to distribute amongst your 4 teammates. You assign them "relative score" of 8 for each. You then click distribute. The total number of "relative scores" will be 32. Each member has 8 relative points, their will all get 8/32*100% = 25% of the total real score. When calculating "real score", each member will get 200 Points * 25% = 50 points / member.
    75   * The above situation would repeat itself if you assigned '''each''' member a slider score, of 2, or 4, or 6, or anything else. Since the number of "relative points" you gave to each member mains equal, they will all be equal relative to one another. It is only the real score for each member that count.
    76   * Quick note: If the above info is confusing, then simply forget about the sliders and Distribute button! Instead, enter the number of points you would like to give to each teammate manually, fill out the comments, and submit your evaluation. Make sure that the points add up to the total number of points to distribute. This is explained in point 3. bellow.
     77  * iPeer will calculate the percentage of "slider-points" you assigned to each of your teammates, and will then calculate how many real points each is given. For example, the evaluation has 200 Real Points to distribute amongst your 4 teammates. You assign them "relative score" of 8 for each. You then click distribute. The total number of "relative scores" will be 32. Each member has 8 relative points, their will all get 8/32*100% = 25% of the total real score. In real score, each member will get 200 Points * 25% = 50 points / member.
     78  * The above situation would repeat itself if you assigned '''each''' member a slider score, of 2, or 4, or 6, or anything else. Since the number of "relative points" you gave to each member mains equal, they will all be equal relative to one another. It is only the real score for each member that counts.
     79  * Quick note: If the above info is confusing, then simply forget about the sliders and Distribute button! Instead, enter the number of points you would like to give to each teammate manually, fill out the comments, and submit your evaluation. Make sure that the points add up to the total number of points to distribute. This is explained in point 3, bellow.
    7780 3. Allocate any remaining points.
    7881  * This step usually occurs in cases where the "Distribute" button could not allocate all the points exactly according to your relative scores.
    7982  * For example, if you relative-scored all your three teammates equally, and the number of total points is 100, the real points cannot be equally divided! Each member would get 33 points, and 33+33+33 = 99, with one real point left to distribute. To distribute this point, you would give one of your team members a score of 34 manually. That way, the total real score would be '''34''' + 33 + 33 = 100, and all points would be distributed.
    80   * If "Distribute" button succeeded in giving everyone an fair score, or if you distributed all the points yourself, this step is obviously unnecessary!
     83  * If "Distribute" button succeeded in giving everyone a fair score, or if you distributed all the points yourself, this step is unnecessary.
    8184 4. Enter Comments
    82   * You may always enter a comment. Some instructors will ''require'' you to enter comments, and ''others will not''. Whatever the case might be, please remember that explaining the reasons for your evaluation of your team-mates is always a good idea!
    83  5. NOTE: "Submit Evaluation" button will only be enabled when all points, and comments (if required), are filled!
     85  * You may always enter a comment. Some instructors will ''require'' you to enter comments, and ''others will not''. Whatever the case might be, please remember that explaining the reasons behind your evaluation of your team-mates is always a good idea!
     86 5. NOTE: "Submit Evaluation" button will only be enabled when all points are distributed, and comments (if required) are filled!
    8487  * Before you submit:
    8588   * Look over your scores one more time.
    8689   * Check that you entered all the comments that you like, or are required to.
    87   * If the Submit button is grayed out, you are missing something. Check the comments and total number of real points once again.
     90  * If the Submit button is grayed out, something is likely missing. Check the comments and total number of real points once again.
    8891
    8992===== Rubric Evaluations =====
     
    134137After your account has been created by an administrator, you are ready to login and use iPeer.
    135138 * You should login with the username and password provided by your admin.
    136  * If you are at UBC, please note that CWL login does not work for instructor accounts. In iPeer, CWL is meant for students only.
     139 * If you are at UBC, please note that CWL login ''does not'' work for instructor accounts. In iPeer, CWL is meant for students only.
    137140Next is a list of steps for new Instructors. To get your courses up and running, you should:
    138  1. First create a course!
     141 1. First, create a course!
    139142 2. Then, add students to your course, either one-by-one, or all at once using a CSV file.
    140  3. Group your students into groups.
    141 You would then be ready to create evaluations for your students to complete:
     143 3. Assign your students into groups.
     144You would then be ready to create evaluations for your students to complete, which is done like this:
    142145 1. Create an Evaluation. There are 3 types available, and each evaluation can be re-used many times.
    143146 2. Create an Evaluation Event. This will give the evaluation to the students to complete, once.
     
    147150
    148151==== Courses ====
    149 Everything in iPeer revolves around courses. Courses has contain student lists, group lists, and evaluation events.
     152All objects in iPeer have some connection with courses. Courses contain student lists, group lists, and evaluation events.
    150153
    151154===== Creating a Course =====
     
    169172 4. Edit any information you choose, and save it by clicking the "Update Course" Button.
    170173
    171 You may also delete your own courses. Please be warned: deleting a course also remove all students from that course, their responses to evaluations for that course, and any evaluation events. If you are absolutely, positively sure that you want to delete a course, this is done by:
     174You may also delete your own courses. Please be warned: deleting a course also removes all students from that course, their responses to evaluations for that course, and any evaluation events. If you are absolutely, positively sure that you want to delete a course, this is done by:
    172175 1. Clicking on the courses tab.
    173176 2. Clicking on the delete icon. The delete icon shown by the red arrow on the image on the upper right (just like the edit icon, in blue).
     
    175178 4. The course is now deleted.
    176179
    177 ==== Course Home Screen
    178 Most functionality is accessed from a courses home screen. You can manage students, groups, and evaluation events from that screen. To activate a courses home screen:
     180==== Course Home Screen ====
     181Most functionality is accessed from a course's home screen. You can manage students, groups, and evaluation events from the home screen. To activate it:
    179182 1. Click on the courses tab.
    180183 2. Click on your course's name or title links. These are orange in color.
     
    182185
    183186==== Students ====
    184 Adding students to your courses can be done in 2 ways, and these are explained bellow
     187Adding students to your courses can be done in 2 ways, and these are explained bellow:
    185188===== Adding Students one by one =====
    186 This method is best for class with few students. Each student is entered manually via iPeer form. For larger classes, it may be better to assemble a CSV form, as described in the next section
     189This method is best for classes with few (10-20) students. Each student is entered manually via iPeer form. For larger classes, it may be better to assemble a CSV form, as described in the next section
    187190 1. Go to a course's home page.
    188   * If the student's menu is hidden, unhide it by clicking "show/hide" link to its right.
     191  * If the student's menu is hidden, un-hide it by clicking "show/hide" link to its right.
    189192 2. Click on "Add Student"
    190193 3. Enter a students data.
    191   * note: Student #, First Name, Last Name are all required. Email is not, and if it is left out, the student will be asked to fill that in.
     194  * note: Student #, First Name, Last Name are all required. Email is not required, and if left out, the student will be asked to fill that in upon their first login.
    192195 4. Click Save to Add the student, the student password will not be randomly generated, the following summary table will appear:
    193196||'''Username'''||'''First Name'''||'''Last Name'''||'''Password'''||
     
    459462
    460463'''Simple Evaluation''':  An evaluation format where members rate other members (possibly themselves) by allocating to each member a portion of a possible mark total (conceptually dividing up money among group members).
    461