UbuntuHelp

Differences between revisions 2 and 19 (spanning 17 versions)
Revision 2 as of 2005-06-17 00:11:55
Size: 3068
Editor: 203-167-186-66
Comment: people don't read tables of contents if they can avoid it
Revision 19 as of 2007-08-03 13:58:50
Size: 479
Editor: 121-72-130-73
Comment: removes obsolete stuff, and makes this a table of contents
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
= Ubuntu Help = These are guidelines on how to write help that is awesomely helpful.
Line 3: Line 3:
This is a suggested outline for Ubuntu Help, the help that appears when someone chooses "Help" from Ubuntu's top-level menus. The help should be aimed at people who already have Ubuntu installed, and need answers fast. They may be complete beginners, businesspeople on a deadline, or harried sysadmins. They may not even have a working Internet connection. The system should integrate help from gnome.org, ubuntu.com, openoffice.org, and anywhere else, because Aunt Tillie doesn't care about those distinctions.  * [:HelpfulHelp:Helpful help] — A roadmap written in the Ubuntu 5.04 era.
Line 5: Line 5:
== Style guide ==  * [:TopicBasedHelp:Topic-based help] — Why we prefer help pages to manuals.
Line 7: Line 7:
People [http://helpware.net/longhorn/review1b.htm#TOC_Index_Search don't read help tables of contents] if they can search instead. So when search is implemented in the help viewer, the main table of contents should be simplified to four or five things that people can glance at while entering their search terms. Until then, it should contain no more than about a dozen subtopics. Local help is faster than the Web, so you can get away with having less on each page, and thereby avoid scrolling. Design for compact layout, so the help viewer can go alongside the software you're wanting help on. Brevity, brevity, brevity.  * [:/PageStructure:Page structure] — How to structure a great help page.
Line 9: Line 9:
== Ubuntu Help ==  * [:/Contents:Table of contents] for Ubuntu Help
Line 11: Line 11:
 * If you're new to Ubuntu 5.10
 * Customizing settings
 * Internet and networking
 * Working with files from Windows
 * Documents, files, and folders
 * Disks and storage devices
 * Music, photos, and video
 * Printing and faxing
 * Keeping your computer safe
 * Maintenance and troubleshooting
 * Advanced topics
 * Getting more help
 * [:/UsingScreenshots:Using screenshots] — how to do it, and why you usually shouldn’t.
Line 24: Line 13:
=== If you're new to Ubuntu 5.10 ===

 * What is Ubuntu?
 * If you've been using Ubuntu 5.04
 * If you've been using Ubuntu 4.10
 * If you've been using Microsoft Windows
 * If you've been using Mac OS X

=== Customizing settings ===

 * Changing the background picture
 * Choosing a screensaver
 * Saving power
 * Accessibility options
 * Keyboard layout
 * Setting the date and time
 * ...

=== Internet and networking ===

 * Connecting to the Internet
 * Finding things on the Web
 * Sending and receiving e-mail
 * Chatting online

 * Connecting to a Windows network
 * Sharing files
 * ...

=== Music, photos, and video ===

 * Listening to music
 * How do I play MP3 files?
 * Copying music from CD to computer
 * Copying music from computer to CD
 * Playing videos
 * ...

=== Printing ===

 * How to set up a printer
 * If printing doesn't work
 * If printing works, but not the way you want

=== Keeping your computer safe ===

 * Use separate accounts for each person
 * Keep your software up to date
 * Set up a firewall
 * ...

=== Maintenance and troubleshooting ===

 * Sound doesn't work
 * Programs keep disappearing or crashing
 * My desktop icons have disappeared
 * A computer has a blank screen
 * A computer is frozen or running very slowly

=== Advanced topics ===

 * Using the terminal
 * Terminal commands reference ("man pages")
 * Setting up a file server
 * Setting up a print server
 * Writing your own programs
 * ...
CategoryDocteam

These are guidelines on how to write help that is awesomely helpful.

  • [:HelpfulHelp:Helpful help] — A roadmap written in the Ubuntu 5.04 era.

  • [:TopicBasedHelp:Topic-based help] — Why we prefer help pages to manuals.

  • [:/PageStructure:Page structure] — How to structure a great help page.

  • [:/Contents:Table of contents] for Ubuntu Help

  • [:/UsingScreenshots:Using screenshots] — how to do it, and why you usually shouldn’t.

CategoryDocteam

UbuntuHelp (last edited 2008-08-06 16:29:32 by localhost)