Milestone 1: Overview

In Milestone 1, you will create a troubleshooting page for your device. A troubleshooting page helps your readers diagnose what is wrong with their device and points them to the correct guide.

Checklist

You are finished with this milestone when your troubleshooting page:

  • Has the correct title
    • Excludes extra descriptive words, such as "laptop," "printer," or "camera"
    • Includes the word "Troubleshooting" in the page title
    • Uses proper spelling, punctuation, and the right device name
  • Is properly formatted
    • Headings are user-experienced symptoms
    • Subheadings are possible causes of those symptoms
    • Solutions are explained in short paragraphs
  • Explains the symptoms of each issue in detail so that a user will know if they are having the same problem
  • Discusses all of the possible causes of each issue in depth
  • Outlines the necessary steps a user must take to return their device to working condition
  • Includes a table of contents
  • Includes placeholder links to applicable guides (actual guide links are added after completing Milestone 3)
  • Incorporates all feedback from the iFixit technical writing team

Email Us When...

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

Overview

A troubleshooting page helps users diagnose a damaged device. Your troubleshooting wiki should list common symptoms of a malfunctioning device and describe possible causes and solutions, listed in order of probability.

Any number of things may be wrong, thus complicating problem diagnosis. The Lenovo Essential G560 troubleshooting page, for example, lists several symptoms, including not powering on, sticky keys, and video distortion. Often, several potential causes exist for any particular symptom.

It is important that your troubleshooting information be as accurate as possible. Writing a good troubleshooting page requires a substantial amount of research—scouring forums, product manuals, and enthusiast sites. It should comprise the most common symptoms people encounter with this device and what solutions have worked for people in the past. It is very important that a troubleshooting page be robust and descriptive.

Example Pages

The following examples from past projects give a good idea of what your completed troubleshooting page should look like.