Milestone 2: Overview

In Milestone 2, you will create a device page. A device page acts like a homepage for all of your other guide pages and helps readers find repair information relevant to their device.

Checklist

You are finished with this milestone when your device page:

  • Has the correct title
    • Excludes extra descriptive words, such as "laptop," "printer," or "camera"
    • Uses proper spelling, punctuation, and the right device name
  • Has a clear, well-lit device photo taken by your team
    • The photo should be in the correct 4:3 aspect ratio
    • The full-size image from the camera should be uploaded
  • Includes the required headings/sections (Background and Identification, Troubleshooting, and Additional Information)
  • Includes thorough information describing the device and its background information to educate readers and aid them in identifying their device
  • Lists at least three helpful, properly formatted links on the device page
  • Is free of major errors in grammar, punctuation, and spelling
  • Incorporates all feedback from the iFixit technical writing team

Email Us When...

...your device page is complete. We’ll be happy to look it over and offer feedback!

Overview

A device page serves as the hub of all the repair information about your device, including background and identification, links to replacement guides, and a link to your troubleshooting page. This screenshot of a completed iPhone 5 device page is a good example of the appropriate length and amount of information you should provide. 

It may look daunting at first, but a good portion of this information is generated automatically. We break it all down for you on the next page.

Example Pages

The following are A-level device pages from past student projects. Use these for inspiration, but don't try to copy them exactly. Bear in mind, these example device pages have extra sections (Tools, Parts, Guides, and Support Questions) that auto-populate once the guides are published, so don't worry if your device page looks slightly different.

 

Creating Your device Page

Page Layout

  • Start a new page by clicking here.
    • If a device page already exists for your device, you shouldn't create a new one. Simply send us an email, and we'll flag the existing page so you can work on it.
       
  • Select "Device" from the list of options.
     
  • Enter your device name in the Title field.
    • The device name should exactly match what appears on the white iFixit label on the device. If you didn't get your device from iFixit, the name should be the same as what appears on the manufacturer's website or in official documentation (owner's manual, etc.)
    • If your device is known by more than one official name, stick with the most common one. (Google Trends can be helpful here.) Alternate model names/numbers can go in the summary (see below).
    • Do NOT include the device type or generic terms such as “laptop,” “cell phone,” etc.
    • Be sure to spell and capitalize your device name properly or your replacement guides will not link correctly.
       
  • Take and upload a picture of the device by clicking on the camera icon in the panel on the right-hand side of the page. The device page picture is the first thing users will notice when they navigate to your device page, so it's important that you take a quality photo.
    • Take the picture with the device against a solid white background that is well-lit, with the camera in landscape orientation.
    • Keep your pictures as large as possible in terms of resolution. If a picture is 4000 x 3000 pixels in size, so be it! We love large images.
    • If you're using a DSLR or other camera that captures images in an aspect ratio other than 4:3, you’ll need to crop your photos to 4:3.
    • The most important thing to remember is to take your own device page picture, rather than taking one from an online image search.
    • Please do NOT use Photoshop to remove photo backgrounds. Your backgrounds don’t have to be perfectly white; a nice uncluttered background is less distracting than one that has been crudely cut out. Even if you really, really know what you’re doing, your time is better spent on other parts of the project.
    • If you're working on a preexisting device page that already has a photo, you should check with us to see whether a new photo is needed. Just drop us an email!
    • For more help on taking great photos, check out our How to Take Awesome Photos guide.
       
  • Enter a short, descriptive summary. The summary should be 1-2 sentences giving the most basic identifying information about the device. Remember that summaries are used in search results, so include key words or phrases you think your readers might search for when looking for help. Always make sure to include alternate model names/numbers, if any.
     
  • Please do not include a table of contents—it's helpful on longer, text-heavy wikis like the troubleshooting page, but it's not needed for your device page.
     
  • Add the Troubleshooting, Background and Identification, and Additional Information headers and their content in the main text box. To create a heading in wiki syntax, simply enclose a word or phrase in double equal signs (e.g. == Troubleshooting ==). Follow the format outlined in this example device page.
    • Troubleshooting This section should be a single sentence linking to the troubleshooting page you created in Milestone 1.
    • Background and Identification This section should include a few paragraphs of info on the device (such as its major features/components, release date, model numbers, known failure modes, any manufacturer recalls, etc.) and how to identify the device (including how to tell it apart from similar models). We want people to have successful repair experiences so it’s important that they are working on the correct device.
      • This, like all of your work, should be written completely in your own words. Although you may find websites that have great descriptions of your device, do not copy and paste these descriptions into your device page, as this is plagiarism. Of course, you’re free to use these websites for reference (don’t forget to credit the source).
    • Additional Information This section should include at least three helpful links to the best online resources for the device. You can link to any helpful source of information, such as other replacement guides, the device’s Wikipedia page, the manufacturer’s device page, product reviews, etc.

The only sections of your device page you need to create manually are Troubleshooting, Background and Identification, and Additional Information. Do not create any Guides, Parts, Support Questions, or Tools sections—these sections will be added to your device page automatically when you create the additional content (just remember to keep the spelling of your device consistent). In addition, some groups may choose to manually create Upgrades and/or Specifications sections; this can be helpful if it's appropriate for your device, but it's not required.

Halt! Who goes there?

Let’s check what’s between your ears! If you’ve got some brains in there, you’ll review the milestone guidelines carefully before you move on. Email us at techwriting[at]ifixit[dot]com when you’ve got a finalized draft of your device page. We’ll look it over and see if it’s clean enough for you to move on to Milestone 3.

Hold It!
LET'S REVIEW THE CHECKLIST...

*Asterisk indicates required field.
Is the device page title capitalized and punctuated correctly with no extra descriptive words, such as “laptop,” “printer,” or “camera?" *
Is the image used for the device picture well-lit, clear, the correct 4:3 aspect ratio, and above all, a photograph taken by the group members? Was the full-size image from the camera uploaded? *
Did the group make proper use of headings and include all of the necessary sections of the device page? *
Is there thorough information describing the device and its history to educate readers and aid them in identifying their device? *
Did the group provide at least three helpful links on the device page that a user would find useful when looking for information on their device? *
Is the device page free of major errors in grammar, punctuation, and spelling? *