TroubleshootingGuide

Differences between revisions 2 and 3
Revision 2 as of 2008-06-07 19:19:11
Size: 1678
Editor: 209
Comment:
Revision 3 as of 2008-06-08 00:39:09
Size: 1920
Editor: 209
Comment:
Deletions are marked like this. Additions are marked like this.
Line 10: Line 10:
A troubleshooting guide intended for new users will provide in depth information on common questions. A troubleshooting section for each category of the documentation intended for new users will provide quick solutions on common questions.
Line 18: Line 18:
Steven heard about an operating system called Ubuntu, and decided to give it a try. Upon installing Ubuntu, he decided to install some applications via Synaptic. After installing several programs, he closed Synaptic. He then remembered there was another application he wanted to install, so he re-opened Synaptic. He then discovered that he could not run Synaptic because he had a '''dpkg --configure -a''' error. His first instinct was to look through the documentation to find information on the topic, but could not. He then went to the forums, where he asked about this issue, and had a reply within 5 minutes. Steven heard about an operating system called Ubuntu, and decided to give it a try. Upon installing Ubuntu, he decided to install some applications via Synaptic. After installing several programs, he closed Synaptic. He then remembered there was another application he wanted to install, so he re-opened Synaptic. He then discovered that he could not run Synaptic because he had a '''dpkg --configure -a''' error. His first instinct was to look through the documentation to find information on the topic, but could not. He then went to the forums, where he asked about this issue, and had a reply and solution within 5 minutes.
Line 26: Line 26:
The troubleshooting docs will be implemented into each category of the documentation. For example, the Customizing your Desktop category will have a troubleshooting section at the end of it.

Summary

A troubleshooting section for each category of the documentation intended for new users will provide quick solutions on common questions.

Rationale

Every single new user to Ubuntu will encounter a problem, in some way or another. A troubleshooting guide containing a large amount of common issues would greatly assist new users.

Use cases

Steven heard about an operating system called Ubuntu, and decided to give it a try. Upon installing Ubuntu, he decided to install some applications via Synaptic. After installing several programs, he closed Synaptic. He then remembered there was another application he wanted to install, so he re-opened Synaptic. He then discovered that he could not run Synaptic because he had a dpkg --configure -a error. His first instinct was to look through the documentation to find information on the topic, but could not. He then went to the forums, where he asked about this issue, and had a reply and solution within 5 minutes.

Design

The troubleshooting guide could be divided into sections, for different issues. For example, 'Installing Ubuntu', 'Graphical Problems', etc.

Implementation

The troubleshooting docs will be implemented into each category of the documentation. For example, the Customizing your Desktop category will have a troubleshooting section at the end of it.

Outstanding issues

There are an extremely large amount of issues that a user that could encounter. It is best to keep the guide at a readable length, so choosing the most common issues will be a necessity.


CategoryDocteam

TroubleshootingGuide (last edited 2008-08-06 16:14:49 by localhost)