Unit 4: Overview

In unit 4, you will conduct a peer review of another group's guides. You will then make final edits to your own guides.

Checklist

You are finished with this unit when you:

  • Reassemble your device

  • Finalize all of your guides, including photos, text, and guide mechanics following the Peer Review Checklist

  • Check that prerequisite guides are used properly

  • Review all text at least twice, to make sure it is correct for peer review

  • Provide written feedback for each part of another group's project that did not follow the Peer Review Checklist

  • Add flags that address each problem with the guides

  • Incorporate the feedback you received from your peer review group and iFixit

  • Email iFixit letting us know you are finished with your project

  • Incorporate all final feedback from the iFixit technical writing team

Email Us When...

...you finish your project. We'll be thrilled to publish your guides for all the world to see! Include any feedback you have on the project. We always want to improve the program for future students.

Overview

After completing the rough drafts for all your replacement guides, you will give your device to another group from your class, and your guides will be reviewed. Be sure to reassemble your own device before giving it to another group for review. Likewise, you will obtain another group's device and review their guides. Use this checklist to thoroughly examine the other group's guides and to provide feedback on any improvements they may need to make. 

Peer review and feedback

Peer review is a form of usability testing, or testing a document to see if it is effective—in this case, to see if users can easily and successfully follow your guide. Usability testing provides an opportunity to find any problems or issues with your guides before they are released.

When you are reviewing other students’ content, it is important to keep a few things in mind:

  • Only give constructive feedback!
  • Point out both corrections and things that were done well.
  • Be as specific as possible, citing specific steps and offering suggestions for changes.
  • Point out anything that is confusing or ambiguous.
  • Use this checklist to evaluate the guides for technical accuracy.

adding flags

In addition to providing written feedback for the group, you will also add flags to their guides. Flags show up at the top of the guide, explaining what things need to be fixed. Check out this page to see a list of flags and what they mean. To add a flag to a guide:

  1. Go into that guide's Edit tab.
  2. Scroll down to the bottom, and select a flag from the drop-down menu below the Flags section.
  3. Choose whichever flag is most applicable to the problem that you observed with the guide. You can add as many flags as necessary to a guide, and they can be deleted once the group fixes the problems.
  4. When you add a flag, you should also write down which flag applies to which step(s) to make sure that the group knows exactly where the mistakes are.

 

final guides

  • At this point, any changes from the peer review should have been made, and all pictures/text/markup should be complete and ready to turn in.
     
  • After making peer review changes, you can delete the corresponding flags from the guide by going into the Edit tab and clicking "Remove" next to the corrected flags.
    • DO NOT remove the "In Progress," "Student Guide," or "Member-Contributed" flags from your guides. We will remove these when we publish your guides.
       
  • Finally, send us an email to let us know that you are finished—and if you’d like some final feedback from iFixit’s technical writing team, be sure to let us know. Lastly, don’t forget to send us your own feedback about the project!
     
SSP_62_spark.jpg

It's dangerous to go alone.

Be sure to have your peer review buddy look over your work. You want your final guides to sparkle. More importantly, they should be helpful to a real user, just like your peer reviewer. Be a pal and return the favor by making sure you’ve followed the guidelines on Unit 4 to give a thorough inspection of their work. Email us at techwriting[at]ifixit[dot]com when you’ve incorporated all the feedback and your guides are ready to share.

Hold It!
LET'S REVIEW THE CHECKLIST... Keep in mind, you're still required to email techwriting[at]ifixit[dot]com to ask for feedback.

*Asterisk indicates required field.
Is your device reassembled? *
Have all pictures been uploaded to the site? *
Have all prerequisite guides been used properly? *
Has all text been reviewed at least twice, to make sure it is correct for group review? *
Has all necessary markup been added to pictures? *
Have all bullets been reviewed, to ensure all appropriate bullet types have been chosen for caution/note bullets? *
Have you provided written feedback for each part of another group's project that did not follow the peer review checklist? *
Have you added flags that address each problem with the guides? *
Have you emailed techwriting[at]ifixit[dot]com to request final feedback? *