EmbeddedHelp

Differences between revisions 2 and 3
⇤ ← Revision 2 as of 2005-10-31 18:35:58 →
Size: 1315
Editor: 187_220_103_66-WIFI_HOTSPOTS
Comment: copy from gobby
← Revision 3 as of 2005-11-02 16:14:54 → ⇥
Size: 2120
Editor: 209
Comment: update from BoF
Deletions are marked like this. Additions are marked like this.
Line 5: Line 5:
 * '''Contributors''': MatthewPaulThomas  * '''Contributors''': MatthewPaulThomas, JeffWaugh
Line 10: Line 10:
The most effective help is individual instructions and examples, one or two sentences each, integrated directly into the interface it is providing help on. Upstreams whose software is included in Ubuntu, especially the less common ones, should The most effective help is individual instructions and examples, one or two sentences each, integrated directly into the interface it is providing help on. Upstreams whose software is included in Ubuntu (''especially'' the less-often used ones) should be encouraged to add such hints, through a section in the HIG and friendly evangelism on mailing lists etc.
Line 14: Line 14:
People other than [http://ui.netbeans.org/usability/Mar_20_02/#help programmers] are [http://tc.eserver.org/10347.html highly reluctant to use anything in the Help menu]. The most useful help is [http://klariti.com/technical-writing/Improve-Usability-Embedded-Help.shtml tips and and hints embedded in the software itself], especially in dialogs and rarely-used windows.
Line 15: Line 17:

 * Sally is trying to log in to her GNOME desktop using a different language. She clicks "Language" on the GDM screen, and wonders why Chinese is not listed, and then how she can make her computer support Chinese.

 * Lu sees the "Sessions" item in the Preferences menu, and wonders what it's for. He's not ''quite'' interested enough to look in the separate help, though. So he closes it and never looks at it again, missing out on the time he would have saved by adding Evolution to his Startup Programs.
Line 18: Line 24:
 * All software in GNOME.
 * All software in main (including OpenOffice.org, Firefox, and Thunderbird).
Line 20: Line 29:
== Imhttps://launchpad.net/distros/ubuntu/+spec/embedded-help

== Summary ==

The most effective help is individual instructions and examples, one or two sentences each, integrated directly into the interface it is providing help on. Upstreams whose software is included in Ubuntu should be encouraged to include such help in their interfaces.

== Rationale ==		 Current examples of embedded help:
 * The blurb at the bottom of the Language Selector (cf. GdmRoadmap).
Line 30: Line 34:

This approach is distributed across dozens of upstream projects, it should be implemented as a section in the Gnome HIG, then evangelized to individual projects.plementation ==

=== Code ===

=== Data preservation and migration ===		 Since this approach is distributed across dozens of upstream projects, it should be implemented as a section in the [http://developer.gnome.org/projects/gup/hig/2.0/ GNOME HIG], then evangelized to individual projects.
Line 38: Line 37:

== BoF agenda and discussion ==

Summary

The most effective help is individual instructions and examples, one or two sentences each, integrated directly into the interface it is providing help on. Upstreams whose software is included in Ubuntu (especially the less-often used ones) should be encouraged to add such hints, through a section in the HIG and friendly evangelism on mailing lists etc.

Rationale

People other than [http://ui.netbeans.org/usability/Mar_20_02/#help programmers] are [http://tc.eserver.org/10347.html highly reluctant to use anything in the Help menu]. The most useful help is [http://klariti.com/technical-writing/Improve-Usability-Embedded-Help.shtml tips and and hints embedded in the software itself], especially in dialogs and rarely-used windows.

Use cases

  • Sally is trying to log in to her GNOME desktop using a different language. She clicks "Language" on the GDM screen, and wonders why Chinese is not listed, and then how she can make her computer support Chinese.

  • Lu sees the "Sessions" item in the Preferences menu, and wonders what it's for. He's not quite interested enough to look in the separate help, though. So he closes it and never looks at it again, missing out on the time he would have saved by adding Evolution to his Startup Programs.

Scope

  • All software in GNOME.

  • All software in main (including OpenOffice.org, Firefox, and Thunderbird).

Design

Current examples of embedded help:

  • The blurb at the bottom of the Language Selector (cf. GdmRoadmap).

Implementation

Since this approach is distributed across dozens of upstream projects, it should be implemented as a section in the [http://developer.gnome.org/projects/gup/hig/2.0/ GNOME HIG], then evangelized to individual projects.

Outstanding issues

EmbeddedHelp (last edited 2008-08-06 16:32:01 by localhost)