TopicBasedHelp

Revision 5 as of 2006-10-17 11:50:51

Clear message

Summary

The help for most Gnome projects, and for Firefox, is written as a manual. This approach works poorly for people trying to find quick answers and read them from a computer screen. Some way needs to be found of splitting help into individual pages that automatically link to each other.

Rationale

Use cases

Scope

Reorganizing the Ubuntu Desktop Guide to a topic-based format. Drawing in relevant documentation from the Official Ubuntu Book and from Ubuntu Forums. Hopefully figuring out a way to integrate these topics directly with the Upstream documentation.

Once this new format is set in place, it will make it easier to draw in new documentation from other sources and place it within the topic-based documentation structure.

This will most likely require an implementation of the project Mallard which the GNOME Documentation team has been working on for the past year. Whether this is ready or not is still not known.

Design

Implementation

Code

Data preservation and migration

Outstanding issues

BoF agenda and discussion

CategorySpec