Creating a Troubleshooting Guide

Definition

A troubleshooting document helps users assess the state of their broken/damaged device. The document will list common problems with the device and describe possible solutions, with more probable solutions coming first. Any number of things may be wrong, complicating problem diagnosis. As you can see in the MacBook troubleshooting guide, the MacBook may not turn on, it may have a flashing question mark on startup, or it may have a non-functional trackpad/keyboard. Often, several solutions exist for any particular problem.

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

Creation

To create a troubleshooting page:

• Copy this link into the address bar: http://www.ifixit.com/Guide/Wiki/Device_Troubleshooting
• Change "Device_Troubleshooting" to whatever the name is of your device. For example, if you are creating a Canon Powershot SD900 troubleshooting guide, the link in the address bar should read http://www.ifixit.com/Guide/Wiki/Canon_Powershot_SD900_Troubleshooting.
• Go to that wiki page and click on the "Create this article" link to start editing the page.

Below is a snippet of the MacBook Troubleshooting guide source code. This should give you an idea of how it's formatted. You can copy/paste the code into a new troubleshooting guide, and then just change text as you see fit.

--------------------------------------------------

[toc]

The MacBook replaces the iBook, with a Intel processor, magnetic Magsafe power connector, integrated iSight camera, and 13.3" widescreen display.

'''Note:''' This troubleshooting guide covers all plastic MacBooks. The MacBook Unibody will be covered in a separate troubleshooting guide.

== MacBook won't turn on ==

''Your computer will not boot.''

=== RAM issues ===

If your computer beeps three times....

--------------------------------------------------

The rest of the troubleshooting guide follows the same format for headings and subheadings. Syntax Options on the right side of the screen (visible when editing your Troubleshooting wiki page) can instruct you on the different formatting options we have available.