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

When you finish this milestone you should have completed the following:

  • Capitalized and punctuated the troubleshooting page title correctly with no extra descriptive words, such as “laptop,” “printer,” or “camera”
  • Included the word “Troubleshooting” in the page title
  • Formatted the troubleshooting page so that headings are user-experienced symptoms, subheadings are possible causes of those symptoms, and solutions are explained in short paragraphs
  • Sorted all of the above in a table of contents at the top of the page
  • Explained the symptoms of each issue so that a user will know if they are having the same problem
  • Discussed and explained all the possible causes to each issue in depth
  • Outlined the necessary steps a user must take to return their device to working condition
  • Provided links to applicable guides (after completing Milestone 3)

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 assess the state of their broken/damaged device. Your troubleshooting wiki should list common symptoms of a malfunctioning device and describe possible causes and solutions, with more probable solutions coming first.

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.