guide mechanics

Clicking on the Details tab at the top of your guide’s Edit page gives you access to some important fields. These fields are critical to help prepare and empower people to fix their device. Before you finalize your new guide, be sure to complete the following:

  • Estimate the time required. Keep track of how long each of your repairs takes (not how long it takes to write the guide), and provide an estimate for your readers. This should be the total time from the start of the repair to the moment it's finished. Remember that you’re writing for a non-technical audience, so it’s best to be a bit conservative with your estimate.
     
  • Estimate the difficulty level. Click on the drop-down menu for an explanation of each difficulty level, and select the most appropriate one. For example, “Easy” requires minimal disassembly and common tools, whereas “Difficult” requires specialty tools or skills such as soldering.
     
  • List any prerequisite guides. (Review this page for an explanation of prerequisites.) To add a prerequisite, simply start typing the name of the component from one of your existing guides—as long as it’s a guide for the same device, it should appear in the drop-down menu.
    • Adding a prerequisite adds ALL of the steps from that guide; you can’t add just one part of a guide. If you delete a step, you will delete it from the original guide, not just the new one.
    • Note that if the guide you’re importing as a prerequisite has any prerequisites of its own, you’ll need to import them separately—they won’t carry over automatically.
       
  • List any required tools. 99% of the tools you are using are already in our database, so as soon as you start typing they should appear in the drop-down menu. If you’re unsure what a tool is called, check the Tools and Materials page. If you need a new tool added, just drop us an email! Remember to include tools used in prerequisite guides as well; you can easily add them by clicking "Import tools from prerequisite guides.”
     
  • Don’t list any required parts. You’re not responsible for sourcing replacement parts for your project.
     
  • Check the conclusion. By default, the conclusion reads, "To reassemble your device, follow these instructions in reverse order," so reassembly steps are not necessary. But if this is not the case (which is rare, but it happens), then reassembly instructions can be added to the applicable step using the "Reminder" bullet. 

YOU SHALL NOT PASS...

...until you review the guidelines of the milestone carefully. There are a lot of tricksy little hobbit-sized details in this milestone that you don’t want to miss. You shall not pass the class without making sure you’ve used all powers of your fellowship (or group) to review your guide. Make sure you’ve got a good pair of elf-eyes on your guides before you email us at techwriting[at]ifixit[dot]com with your finalized drafts. We’ll let you know when it’s safe to cross into Milestone 4.